From 02b81f75c4299bcbf26c22b5091498c358046add Mon Sep 17 00:00:00 2001 From: mpothuganti <92181739+mpothuganti@users.noreply.github.com> Date: Mon, 26 Aug 2024 11:00:14 -0700 Subject: [PATCH 01/30] Add new API version for Hybrid connectivity 2024 12 01 (#30287) * Copy files from stable/2023-03-15 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-12-01 Updated the API version from stable/2023-03-15 to stable/2024-12-01. * Added tag for 2024-12-01 in readme file * Fix Prettier issue --- .../examples/EndpointsDeleteDefault.json | 11 + .../examples/EndpointsGetCustom.json | 20 + .../examples/EndpointsGetDefault.json | 19 + .../2024-12-01/examples/EndpointsList.json | 31 + .../examples/EndpointsPatchDefault.json | 25 + .../EndpointsPostListCredentials.json | 25 + ...intsPostListIngressGatewayCredentials.json | 32 + .../EndpointsPostListManagedProxyDetails.json | 20 + .../examples/EndpointsPutCustom.json | 27 + .../examples/EndpointsPutDefault.json | 25 + .../2024-12-01/examples/OperationsList.json | 93 ++ .../ServiceConfigurationsDeleteSSH.json | 12 + .../examples/ServiceConfigurationsGetSSH.json | 20 + .../examples/ServiceConfigurationsGetWAC.json | 20 + .../examples/ServiceConfigurationsList.json | 31 + .../ServiceConfigurationsPatchSSH.json | 24 + .../examples/ServiceConfigurationsPutSSH.json | 38 + .../examples/ServiceConfigurationsPutWAC.json | 38 + .../stable/2024-12-01/hybridconnectivity.json | 1122 +++++++++++++++++ .../resource-manager/readme.md | 11 +- 20 files changed, 1643 insertions(+), 1 deletion(-) create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsDeleteDefault.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetCustom.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetDefault.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsList.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPatchDefault.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListCredentials.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListIngressGatewayCredentials.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListManagedProxyDetails.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutCustom.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutDefault.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/OperationsList.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsDeleteSSH.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetSSH.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetWAC.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsList.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPatchSSH.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutSSH.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutWAC.json create mode 100644 specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/hybridconnectivity.json diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsDeleteDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsDeleteDefault.json new file mode 100644 index 000000000000..b6396a9b9012 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsDeleteDefault.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01", + "endpointName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetCustom.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetCustom.json new file mode 100644 index 000000000000..697972eb9cf0 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetCustom.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01", + "endpointName": "custom" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/custom", + "name": "custom", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetDefault.json new file mode 100644 index 000000000000..64af9a019add --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsGetDefault.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01", + "endpointName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsList.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsList.json new file mode 100644 index 000000000000..ec248b14d4dd --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default" + } + }, + { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/custom", + "name": "custom", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace" + } + } + ] + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPatchDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPatchDefault.json new file mode 100644 index 000000000000..6da3b9855607 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPatchDefault.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01", + "endpointName": "default", + "EndpointResource": { + "properties": { + "type": "default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListCredentials.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListCredentials.json new file mode 100644 index 000000000000..5206f7fbfff7 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListCredentials.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01", + "endpointName": "default", + "expiresin": 10800, + "ListCredentialsRequest": { + "serviceName": "SSH" + } + }, + "responses": { + "200": { + "body": { + "relay": { + "namespaceName": "azgnrelay-eastus-l1", + "namespaceNameSuffix": "servicebus.windows.net", + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/a0e1fd7d1d974ddf6b11a952d67679c9f12c006eee16861857a8268da4eb1498/1619989456957411072", + "accessKey": "SharedAccessSignature sr=http%3A%2F%2Fazgnrelay-eastus-l1.servicebus.windows.net%2Fmicrosoft.kubernetes%2Fconnectedclusters%2Fa0e1fd7d1d974ddf6b11a952d67679c9f12c006eee16861857a8268da4eb1498%2F1619989456957411072%2F&sig=WxDwPF6AmmODaMHNnBGDSm773UG%2B%2Be", + "expiresOn": 1620000256, + "serviceConfigurationToken": "SSHvjqH=pTlKql=RtMGw/-k5VFBxSYHIiq5ZgbGFcLkNrDNz5fDsinCN2zkG" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListIngressGatewayCredentials.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListIngressGatewayCredentials.json new file mode 100644 index 000000000000..2213674b993b --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListIngressGatewayCredentials.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/arcGroup/providers/Microsoft.ArcPlaceHolder/ProvisionedClusters/cluster0", + "api-version": "2024-12-01", + "endpointName": "default", + "expiresin": 10800, + "ListCredentialsRequest": { + "serviceName": "SSH" + } + }, + "responses": { + "200": { + "body": { + "relay": { + "namespaceName": "relaynamespace", + "namespaceNameSuffix": "servicebus.windows.net", + "hybridConnectionName": "microsoft.arcplaceholder/provisionedclusters/000/1619989456957411072", + "accessKey": "SharedAccessSignature sr=http%3A%2F%2Fazgnrelay-eastus-l1.servicebus.windows.net%2Fmicrosoft.provisionedcluster%hci", + "expiresOn": 1620000256, + "serviceConfigurationToken": "SSHvjqH=pTlKql=RtMGw/-k5VFBxSYHIiq5ZgbGFcLkNrDNz5fDsinCN2zkG" + }, + "ingress": { + "hostname": "clusterhostname", + "aadProfile": { + "serverId": "6256c85f-0aad-4d50-b960-e6e9b21efe35", + "tenantId": "hy657tgh-8d16-42db-81b7-1234hygt67hy5" + } + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListManagedProxyDetails.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListManagedProxyDetails.json new file mode 100644 index 000000000000..a1cf3c99bc81 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPostListManagedProxyDetails.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/arcGroup/providers/Microsoft.Compute/virtualMachines/vm00006", + "api-version": "2024-12-01", + "endpointName": "default", + "ManagedProxyRequest": { + "service": "127.0.0.1:65035", + "hostname": "r.proxy.arc.com", + "serviceName": "WAC" + } + }, + "responses": { + "200": { + "body": { + "proxy": "uid.r.proxy.arc.com", + "expiresOn": 1620000256 + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutCustom.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutCustom.json new file mode 100644 index 000000000000..c9e9145ffd0b --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutCustom.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01", + "endpointName": "custom", + "EndpointResource": { + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/custom", + "name": "custom", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutDefault.json new file mode 100644 index 000000000000..6da3b9855607 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/EndpointsPutDefault.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-12-01", + "endpointName": "default", + "EndpointResource": { + "properties": { + "type": "default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/OperationsList.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/OperationsList.json new file mode 100644 index 000000000000..cb9a58454075 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/OperationsList.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HybridConnectivity/operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "Operations", + "operation": "Get operations", + "description": "Get the list of Operations" + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "Get/List endpoints", + "description": "Get or list of endpoints to the target resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "Create/Update endpoint", + "description": "Create or update the endpoint to the target resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "Delete endpoint", + "description": "Deletes the endpoint access to the target resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/listCredentials/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "List credentials for endpoint access", + "description": "List the endpoint access credentials to the resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/listIngressGatewayCredentials/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "List credentials for ingress gateway", + "description": "List the ingress gateway credentials to the resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "Microsoft.HybridConnectivity", + "operation": "Register the Microsoft.HybridConnectivity", + "description": "Register the subscription for Microsoft.HybridConnectivity" + } + }, + { + "name": "Microsoft.HybridConnectivity/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "Microsoft.HybridConnectivity", + "operation": "Unregister the Microsoft.HybridConnectivity", + "description": "Unregister the subscription for Microsoft.HybridConnectivity" + } + } + ] + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsDeleteSSH.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsDeleteSSH.json new file mode 100644 index 000000000000..2b2b0f7ef955 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsDeleteSSH.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "api-version": "2024-12-01", + "endpointName": "default", + "serviceConfigurationName": "SSH" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetSSH.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetSSH.json new file mode 100644 index 000000000000..3a46bb9544cd --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetSSH.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "api-version": "2024-12-01", + "endpointName": "default", + "serviceConfigurationName": "SSH" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/SSH", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "SSH", + "port": 22 + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetWAC.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetWAC.json new file mode 100644 index 000000000000..da145f967f75 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsGetWAC.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "api-version": "2024-12-01", + "endpointName": "default", + "serviceConfigurationName": "WAC" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/WAC", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "WAC", + "port": 6516 + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsList.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsList.json new file mode 100644 index 000000000000..e98c89eb0c5c --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "endpointName": "default", + "api-version": "2024-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/SSH", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "SSH", + "port": 22 + } + }, + { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/WAC", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "WAC", + "port": 6516 + } + } + ] + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPatchSSH.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPatchSSH.json new file mode 100644 index 000000000000..852d670a1485 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPatchSSH.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "api-version": "2024-12-01", + "endpointName": "default", + "serviceConfigurationName": "SSH", + "ServiceConfigurationResource": { + "properties": { + "port": 22 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceConfigurations/SSH", + "properties": { + "serviceName": "SSH", + "port": 22 + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutSSH.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutSSH.json new file mode 100644 index 000000000000..e14b99d0adad --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutSSH.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "api-version": "2024-12-01", + "endpointName": "default", + "serviceConfigurationName": "SSH", + "ServiceConfigurationResource": { + "properties": { + "serviceName": "SSH", + "port": 22 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/SSH", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "SSH", + "port": 22, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/SSH", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "SSH", + "port": 22, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutWAC.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutWAC.json new file mode 100644 index 000000000000..267c29fff9b4 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/examples/ServiceConfigurationsPutWAC.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "api-version": "2024-12-01", + "endpointName": "default", + "serviceConfigurationName": "WAC", + "ServiceConfigurationResource": { + "properties": { + "serviceName": "WAC", + "port": 6516 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/WAC", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "WAC", + "port": 6516, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default/serviceconfigurations/WAC", + "type": "Microsoft.HybridConnectivity/endpoints/serviceConfigurations", + "properties": { + "serviceName": "WAC", + "port": 6516, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/hybridconnectivity.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/hybridconnectivity.json new file mode 100644 index 000000000000..5fc56c8b3135 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2024-12-01/hybridconnectivity.json @@ -0,0 +1,1122 @@ +{ + "swagger": "2.0", + "info": { + "title": "Hybrid Connectivity Management API", + "description": "REST API for Hybrid Connectivity", + "version": "2024-12-01" + }, + "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.HybridConnectivity/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the available Hybrid Connectivity REST API operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityOperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation details.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "List of endpoints to the target resource.", + "operationId": "Endpoints_List", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsGet": { + "$ref": "./examples/EndpointsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "List of endpoints.", + "schema": { + "$ref": "#/definitions/EndpointsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Gets the endpoint to the resource.", + "operationId": "Endpoints_Get", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsGetDefault": { + "$ref": "./examples/EndpointsGetDefault.json" + }, + "HybridConnectivityEndpointsGetCustom": { + "$ref": "./examples/EndpointsGetCustom.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + } + ], + "responses": { + "200": { + "description": "Endpoint details", + "schema": { + "$ref": "#/definitions/EndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Create or update the endpoint to the target resource.", + "operationId": "Endpoints_CreateOrUpdate", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPutDefault": { + "$ref": "./examples/EndpointsPutDefault.json" + }, + "HybridConnectivityEndpointsPutCustom": { + "$ref": "./examples/EndpointsPutCustom.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "name": "EndpointResource", + "description": "Endpoint details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Endpoint details.", + "schema": { + "$ref": "#/definitions/EndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Endpoints" + ], + "description": "Update the endpoint to the target resource.", + "operationId": "Endpoints_Update", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPatchDefault": { + "$ref": "./examples/EndpointsPatchDefault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "name": "EndpointResource", + "description": "Endpoint details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Endpoint resource.", + "schema": { + "$ref": "#/definitions/EndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Deletes the endpoint access to the target resource.", + "operationId": "Endpoints_Delete", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsDeleteDefault": { + "$ref": "./examples/EndpointsDeleteDefault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + } + ], + "responses": { + "200": { + "description": "The endpoint is deleted successfully." + }, + "204": { + "description": "The endpoint has been deleted already." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations": { + "get": { + "tags": [ + "ServiceConfigurations" + ], + "summary": "Lists of all the services associated with endpoint resource.", + "operationId": "ServiceConfigurations_ListByEndpointResource", + "description": "API to enumerate registered services in service configurations under a Endpoint Resource", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClustersExample": { + "$ref": "./examples/ServiceConfigurationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}": { + "get": { + "tags": [ + "ServiceConfigurations" + ], + "description": "Gets the details about the service to the resource.", + "operationId": "ServiceConfigurations_Get", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsServiceconfigurationsGetSSH": { + "$ref": "./examples/ServiceConfigurationsGetSSH.json" + }, + "HybridConnectivityEndpointsServiceconfigurationsGetWAC": { + "$ref": "./examples/ServiceConfigurationsGetWAC.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/ServiceConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Service configuration resource request was successful", + "schema": { + "$ref": "#/definitions/ServiceConfigurationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "ServiceConfigurations" + ], + "description": "Create or update a service in serviceConfiguration for the endpoint resource.", + "operationId": "ServiceConfigurations_CreateOrupdate", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "ServiceConfigurationsPutSSH": { + "$ref": "./examples/ServiceConfigurationsPutSSH.json" + }, + "ServiceConfigurationsPutWAC": { + "$ref": "./examples/ServiceConfigurationsPutWAC.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/ServiceConfigurationNameParameter" + }, + { + "name": "ServiceConfigurationResource", + "description": "Service details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceConfigurationResource" + } + } + ], + "responses": { + "200": { + "description": "ServiceConfiguration resource create request was successful.", + "schema": { + "$ref": "#/definitions/ServiceConfigurationResource" + } + }, + "201": { + "description": "ServiceConfiguration resource is successfully created.", + "schema": { + "$ref": "#/definitions/ServiceConfigurationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ServiceConfigurations" + ], + "description": "Update the service details in the service configurations of the target resource.", + "operationId": "ServiceConfigurations_Update", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "ServiceConfigurationsPatchSSH": { + "$ref": "./examples/ServiceConfigurationsPatchSSH.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/ServiceConfigurationNameParameter" + }, + { + "name": "ServiceConfigurationResource", + "description": "Service details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceConfigurationResourcePatch" + } + } + ], + "responses": { + "200": { + "description": "ServiceConfiguration service.", + "schema": { + "$ref": "#/definitions/ServiceConfigurationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ServiceConfigurations" + ], + "description": "Deletes the service details to the target resource.", + "operationId": "ServiceConfigurations_Delete", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "ServiceConfigurationsDeleteSSH": { + "$ref": "./examples/ServiceConfigurationsDeleteSSH.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/ServiceConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "The service configuration resource is deleted successfully." + }, + "204": { + "description": "The service configuration resource has been deleted already." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listCredentials": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Gets the endpoint access credentials to the resource.", + "operationId": "Endpoints_ListCredentials", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPostListCredentials": { + "$ref": "./examples/EndpointsPostListCredentials.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/AccessTokenExpirationParameter" + }, + { + "name": "ListCredentialsRequest", + "in": "body", + "schema": { + "$ref": "#/definitions/ListCredentialsRequest" + }, + "description": "Object of type ListCredentialsRequest" + } + ], + "responses": { + "200": { + "description": "Endpoint access credentials", + "schema": { + "$ref": "#/definitions/EndpointAccessResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listIngressGatewayCredentials": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Gets the ingress gateway endpoint credentials ", + "operationId": "Endpoints_ListIngressGatewayCredentials", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPostListIngressGatewayCredentials": { + "$ref": "./examples/EndpointsPostListIngressGatewayCredentials.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/AccessTokenExpirationParameter" + }, + { + "name": "ListIngressGatewayCredentialsRequest", + "in": "body", + "schema": { + "$ref": "#/definitions/ListIngressGatewayCredentialsRequest" + }, + "description": "Object of type ListIngressGatewayCredentialsRequest" + } + ], + "responses": { + "200": { + "description": "Ingress gateway access", + "schema": { + "$ref": "#/definitions/IngressGatewayResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listManagedProxyDetails": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Fetches the managed proxy details ", + "operationId": "Endpoints_ListManagedProxyDetails", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPostListManagedProxyDetails": { + "$ref": "./examples/EndpointsPostListManagedProxyDetails.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "name": "ManagedProxyRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedProxyRequest" + }, + "description": "Object of type ManagedProxyRequest" + } + ], + "responses": { + "200": { + "description": "Managed Proxy", + "schema": { + "$ref": "#/definitions/ManagedProxyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "RelayNamespaceAccessProperties": { + "type": "object", + "description": "Azure relay hybrid connection access properties", + "required": [ + "namespaceName", + "namespaceNameSuffix", + "hybridConnectionName" + ], + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name.", + "minLength": 1, + "maxLength": 200 + }, + "namespaceNameSuffix": { + "type": "string", + "description": "The suffix domain name of relay namespace.", + "minLength": 1, + "maxLength": 100 + }, + "hybridConnectionName": { + "type": "string", + "description": "Azure Relay hybrid connection name for the resource." + }, + "accessKey": { + "type": "string", + "description": "Access key for hybrid connection.", + "readOnly": true + }, + "expiresOn": { + "type": "integer", + "format": "int64", + "description": "The expiration of access key in unix time." + }, + "serviceConfigurationToken": { + "type": "string", + "description": "The token to access the enabled service.", + "x-ms-secret": true + } + } + }, + "IngressGatewayResource": { + "description": "The ingress gateway access credentials", + "type": "object", + "properties": { + "relay": { + "$ref": "#/definitions/RelayNamespaceAccessProperties", + "x-ms-client-flatten": true + }, + "ingress": { + "$ref": "#/definitions/IngressProfileProperties", + "x-ms-client-flatten": true + } + } + }, + "IngressProfileProperties": { + "type": "object", + "description": "Ingress gateway profile", + "required": [ + "hostname", + "aadProfile" + ], + "properties": { + "hostname": { + "type": "string", + "description": "The ingress hostname." + }, + "aadProfile": { + "$ref": "#/definitions/AADProfileProperties", + "x-ms-client-flatten": true + } + } + }, + "AADProfileProperties": { + "type": "object", + "description": "The AAD Profile", + "required": [ + "serverId", + "tenantId" + ], + "properties": { + "serverId": { + "type": "string", + "description": "The arc ingress gateway server app id." + }, + "tenantId": { + "type": "string", + "description": "The target resource home tenant id." + } + } + }, + "EndpointAccessResource": { + "description": "The endpoint access for the target resource.", + "type": "object", + "properties": { + "relay": { + "$ref": "#/definitions/RelayNamespaceAccessProperties", + "x-ms-client-flatten": true + } + } + }, + "EndpointProperties": { + "type": "object", + "description": "Endpoint details", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of endpoint.", + "enum": [ + "default", + "custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true + } + }, + "resourceId": { + "type": "string", + "description": "The resource Id of the connectivity endpoint (optional)." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The resource provisioning state." + } + } + }, + "ServiceConfigurationList": { + "description": "The paginated list of serviceConfigurations", + "type": "object", + "properties": { + "value": { + "description": "The list of service configuration", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceConfigurationResource" + } + }, + "nextLink": { + "description": "The link to fetch the next page of connected cluster", + "type": "string" + } + } + }, + "EndpointResource": { + "description": "The endpoint for the target resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "description": "System data of endpoint resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "x-ms-client-flatten": true + }, + "properties": { + "description": "The endpoint properties.", + "$ref": "#/definitions/EndpointProperties", + "x-ms-client-flatten": false + } + } + }, + "ServiceConfigurationResource": { + "description": "The service configuration details associated with the target resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "description": "System data of endpoint resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "x-ms-client-flatten": true + }, + "properties": { + "description": "The service configuration properties.", + "$ref": "#/definitions/ServiceConfigurationProperties", + "x-ms-client-flatten": true + } + } + }, + "ServiceConfigurationProperties": { + "type": "object", + "description": "Service configuration details", + "required": [ + "serviceName" + ], + "properties": { + "serviceName": { + "type": "string", + "description": "Name of the service.", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + }, + "resourceId": { + "type": "string", + "description": "The resource Id of the connectivity endpoint (optional)." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The port on which service is enabled." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The resource provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "ServiceConfigurationResourcePatch": { + "description": "The service details under service configuration for the target endpoint resource.", + "type": "object", + "properties": { + "properties": { + "description": "The service configuration properties.", + "$ref": "#/definitions/ServiceConfigurationPropertiesPatch", + "x-ms-client-flatten": true + } + } + }, + "ServiceConfigurationPropertiesPatch": { + "type": "object", + "description": "Service configuration details", + "properties": { + "port": { + "type": "integer", + "format": "int64", + "description": "The port on which service is enabled." + } + } + }, + "EndpointsList": { + "description": "The list of endpoints.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of endpoints list.", + "type": "string" + }, + "value": { + "description": "The list of endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointResource" + } + } + } + }, + "ManagedProxyResource": { + "type": "object", + "description": "Managed Proxy", + "required": [ + "proxy", + "expiresOn" + ], + "properties": { + "proxy": { + "type": "string", + "description": "The short lived proxy name." + }, + "expiresOn": { + "type": "integer", + "format": "int64", + "description": "The expiration time of short lived proxy name in unix epoch." + } + } + }, + "ManagedProxyRequest": { + "type": "object", + "description": "Represent ManageProxy Request object.", + "required": [ + "service" + ], + "properties": { + "service": { + "type": "string", + "description": "The name of the service." + }, + "hostname": { + "type": "string", + "description": "The target host name." + }, + "serviceName": { + "type": "string", + "description": "The name of the service. It is an optional property, if not provided, service configuration tokens issue code would be by passed.", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + } + } + }, + "ListCredentialsRequest": { + "type": "object", + "description": "The details of the service for which credentials needs to be returned.", + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service. If not provided, the request will by pass the generation of service configuration token ", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + } + } + }, + "ListIngressGatewayCredentialsRequest": { + "type": "object", + "description": "Represent ListIngressGatewayCredentials Request object.", + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service.", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified Azure Resource manager identifier of the resource to be connected.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "EndpointNameParameter": { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The endpoint name.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ServiceConfigurationNameParameter": { + "name": "serviceConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The service name.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "AccessTokenExpirationParameter": { + "name": "expiresin", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "default": 10800, + "minimum": 600, + "maximum": 10800, + "description": "The is how long the endpoint access token is valid (in seconds).", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/readme.md b/specification/hybridconnectivity/resource-manager/readme.md index b6d379086289..31d37cc5ed15 100644 --- a/specification/hybridconnectivity/resource-manager/readme.md +++ b/specification/hybridconnectivity/resource-manager/readme.md @@ -27,10 +27,19 @@ These are the global settings for the hybridconnectivity. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-03 +tag: package-2024-12 ``` +### Tag: package-2024-12 + +These settings apply only when `--tag=package-2024-12` is specified on the command line. + +```yaml $(tag) == 'package-2024-12' +input-file: + - Microsoft.HybridConnectivity/stable/2024-12-01/hybridconnectivity.json +``` + ### Tag: package-2023-03 These settings apply only when `--tag=package-2023-03` is specified on the command line. From 260651b67269ee08d515b2bae9d2e9f9c5732c42 Mon Sep 17 00:00:00 2001 From: Badea Marjieh <127952241+badeamarjieh@users.noreply.github.com> Date: Mon, 26 Aug 2024 21:54:31 +0300 Subject: [PATCH 02/30] Update Spec to Match Backend - Add 200 Status Code for Resume and Suspend APIs (#30253) * . * fix typo * add suppresions.yaml * add suppressions to readme.md --- .../Microsoft.Fabric.Management/capacity.tsp | 14 ++++++++++++-- .../2023-11-01/FabricCapacities_Resume.json | 1 + .../2023-11-01/FabricCapacities_Suspend.json | 1 + .../examples/FabricCapacities_Resume.json | 1 + .../examples/FabricCapacities_Suspend.json | 1 + .../Microsoft.Fabric/stable/2023-11-01/fabric.json | 14 ++++++++++++++ specification/fabric/resource-manager/readme.md | 4 ++++ 7 files changed, 34 insertions(+), 2 deletions(-) diff --git a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp index c2f4407acd4e..94c6fad070ee 100644 --- a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp +++ b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp @@ -45,10 +45,10 @@ interface FabricCapacities { listBySubscription is ArmListBySubscription; @doc("Resume operation of the specified Fabric capacity instance.") - resume is ArmResourceActionNoResponseContentAsync; + resume is ArmResourceActionAsync; @doc("Suspend operation of the specified Fabric capacity instance.") - suspend is ArmResourceActionNoResponseContentAsync; + suspend is ArmResourceActionAsync; checkNameAvailability is checkLocalNameAvailability; @@ -74,3 +74,13 @@ interface FabricCapacities { ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, ): RpSkuEnumerationForNewResourceResult | ErrorResponse; } + +@doc("The capacity was successfully suspended") +model SuspendOkStatusCode { + ...OkResponse; +} + +@doc("The capacity was successfully resumed") +model ResumeOkStatusCode { + ...OkResponse; +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json index ec90eb13207e..b80c7f8adf4f 100644 --- a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json @@ -8,6 +8,7 @@ "capacityName": "azsdktest" }, "responses": { + "200": {}, "202": { "headers": { "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json index 7507ad604a2f..14fd5b186f12 100644 --- a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json @@ -8,6 +8,7 @@ "capacityName": "azsdktest" }, "responses": { + "200": {}, "202": { "headers": { "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json index ec90eb13207e..b80c7f8adf4f 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json @@ -8,6 +8,7 @@ "capacityName": "azsdktest" }, "responses": { + "200": {}, "202": { "headers": { "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json index 7507ad604a2f..14fd5b186f12 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json @@ -8,6 +8,7 @@ "capacityName": "azsdktest" }, "responses": { + "200": {}, "202": { "headers": { "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json index f9be285b9349..1018facc7be8 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json @@ -542,6 +542,9 @@ } ], "responses": { + "200": { + "description": "The capacity was successfully resumed" + }, "202": { "description": "Resource operation accepted.", "headers": { @@ -648,6 +651,9 @@ } ], "responses": { + "200": { + "description": "The capacity was successfully suspended" + }, "202": { "description": "Resource operation accepted.", "headers": { @@ -935,6 +941,10 @@ ] } }, + "ResumeOkStatusCode": { + "type": "object", + "description": "The capacity was successfully resumed" + }, "RpSku": { "type": "object", "description": "Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.", @@ -1077,6 +1087,10 @@ } ] } + }, + "SuspendOkStatusCode": { + "type": "object", + "description": "The capacity was successfully suspended" } }, "parameters": { diff --git a/specification/fabric/resource-manager/readme.md b/specification/fabric/resource-manager/readme.md index 9963df034821..617d8d2ed09c 100644 --- a/specification/fabric/resource-manager/readme.md +++ b/specification/fabric/resource-manager/readme.md @@ -41,6 +41,10 @@ These settings apply only when `--tag=package-2023-11-01` is specified on the co ```yaml $(tag) == 'package-2023-11-01' input-file: - Microsoft.Fabric/stable/2023-11-01/fabric.json +suppressions: + - code: PostResponseCodes + reason: 2 POST Methods Resume and Suspend are LRO and the result returns 200 OK with no schema. It would take a while to fix the backend to return 204. Once fixed, will publish a new version. Specifying only 202 causes failues in the Az CLI Tools generation. + from: fabric.json ``` --- From 9af69911e3745721eacc27a43a14b128b70155c1 Mon Sep 17 00:00:00 2001 From: Chinonso Chukwuogor Date: Mon, 26 Aug 2024 15:02:19 -0700 Subject: [PATCH 03/30] fix: Fix enum in Microsoft.iotoperations@2024-08-15-preview (#30303) * fix: Fix enum in 2024-08-15-preview * tsv * QoS 2 not supported * Kafka host value should be required * MQTT host should be nullable * generate updates to schema --------- Co-authored-by: John Lian --- .../IoTOperations.Management/models/base.tsp | 9 +++++ .../models/dataflows/dataflowEndpoints.tsp | 8 ++--- .../2024-08-15-preview/iotoperations.json | 34 ++++++++++++++----- 3 files changed, 39 insertions(+), 12 deletions(-) diff --git a/specification/iotoperations/IoTOperations.Management/models/base.tsp b/specification/iotoperations/IoTOperations.Management/models/base.tsp index dd4beacde903..6bc94b68d6cd 100644 --- a/specification/iotoperations/IoTOperations.Management/models/base.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/base.tsp @@ -191,6 +191,7 @@ alias AccessToken = "AccessToken"; alias Sasl = "Sasl"; alias X509Certificate = "X509Certificate"; alias Anonymous = "Anonymous"; +alias ServiceAccountToken = "ServiceAccountToken"; @doc("Managed Identity Method") union ManagedIdentityMethod { @@ -234,3 +235,11 @@ union AnonymousMethod { @doc("Anonymous Option") Anonymous: Anonymous, } + +@doc("Service Account Token Method") +union ServiceAccountTokenMethod { + string, + + @doc("ServiceAccountToken Option") + ServiceAccountToken: ServiceAccountToken, +} diff --git a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp index 6a6da31b4cd1..ab49733743ad 100644 --- a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp @@ -206,7 +206,7 @@ model DataflowEndpointKafka { consumerGroupId?: string; @doc("Kafka endpoint host.") - host?: string; + host: string; @doc("Batching configuration.") batching?: DataflowEndpointKafkaBatching; @@ -336,7 +336,7 @@ model DataflowEndpointMqtt { clientIdPrefix?: string; @doc("Host of the Broker in the form of :. Optional; connects to Broker if omitted.") - host?: string = "aio-mq-dmqtt-frontend:8883"; + host?: string; @doc("Enable or disable websockets.") protocol?: BrokerProtocolType = BrokerProtocolType.Mqtt; @@ -354,7 +354,7 @@ model DataflowEndpointMqtt { @doc("Qos for Broker connection.") @minValue(0) - @maxValue(2) + @maxValue(1) qos?: int32 = 1; @doc("Session expiry in seconds.") @@ -385,7 +385,7 @@ model DataflowEndpointMqttAuthentication { @doc("DataflowEndpoint Mqtt Authentication Method properties") union MqttAuthMethod { ManagedIdentityMethod, - SaslMethod, + ServiceAccountTokenMethod, x509CertificateMethod, AnonymousMethod, } diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-08-15-preview/iotoperations.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-08-15-preview/iotoperations.json index 0f037174bb61..47c0ef465b8b 100644 --- a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-08-15-preview/iotoperations.json +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-08-15-preview/iotoperations.json @@ -4414,7 +4414,8 @@ } }, "required": [ - "authentication" + "authentication", + "host" ] }, "DataflowEndpointKafkaAcks": { @@ -4630,8 +4631,7 @@ }, "host": { "type": "string", - "description": "Host of the Broker in the form of :. Optional; connects to Broker if omitted.", - "default": "aio-mq-dmqtt-frontend:8883" + "description": "Host of the Broker in the form of :. Optional; connects to Broker if omitted." }, "protocol": { "type": "string", @@ -4703,7 +4703,7 @@ "description": "Qos for Broker connection.", "default": 1, "minimum": 0, - "maximum": 2 + "maximum": 1 }, "sessionExpirySeconds": { "type": "integer", @@ -5668,7 +5668,7 @@ "enum": [ "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity", - "Sasl", + "ServiceAccountToken", "X509Certificate", "Anonymous" ], @@ -5687,9 +5687,9 @@ "description": "UserAssignedManagedIdentity type" }, { - "name": "Sasl", - "value": "Sasl", - "description": "Sasl Option" + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken Option" }, { "name": "X509Certificate", @@ -6193,6 +6193,24 @@ } } }, + "ServiceAccountTokenMethod": { + "type": "string", + "description": "Service Account Token Method", + "enum": [ + "ServiceAccountToken" + ], + "x-ms-enum": { + "name": "ServiceAccountTokenMethod", + "modelAsString": true, + "values": [ + { + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken Option" + } + ] + } + }, "ServiceType": { "type": "string", "description": "Kubernetes Service Types supported by Listener", From db56f00e2c5c6cf5e057438d6e69d3e929103f19 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Mon, 26 Aug 2024 18:44:43 -0500 Subject: [PATCH 04/30] [TypeSpecValidation] Add suppression mechanism specific to TSV-All (#30324) - Also adds "DryRun" param for debugging --- eng/scripts/Suppressions-Functions.ps1 | 60 ++++++++++++++++++++++++++ eng/scripts/TypeSpec-Requirement.ps1 | 18 ++------ eng/scripts/TypeSpec-Validation.ps1 | 19 ++++++++ 3 files changed, 83 insertions(+), 14 deletions(-) create mode 100644 eng/scripts/Suppressions-Functions.ps1 diff --git a/eng/scripts/Suppressions-Functions.ps1 b/eng/scripts/Suppressions-Functions.ps1 new file mode 100644 index 000000000000..799281feae16 --- /dev/null +++ b/eng/scripts/Suppressions-Functions.ps1 @@ -0,0 +1,60 @@ +<# +.DESCRIPTION + Returns the suppressions for a tool applicable to a path. Walks up the directory tree to find all files named + "suppressions.yaml", parses and validates the contents, and returns the suppressions matching the tool and path. + Suppressions are ordered by file (closest to path is first), then within the file (closest to top is first). + +.PARAMETER Tool + Name of tool. Matched against property "tool" in suppressions.yaml. + +.PARAMETER Path + Path to file or directory under analysis. + +.OUTPUTS + Hashtable[] + Array of suppressions matching tool and path (may be empty). See the "get-suppressions" tool for the definition + of the suppression object. +#> +function Get-Suppressions { + param ( + [string]$Tool, + [string]$Path + ) + + # -NoEnumerate to prevent single-element arrays from being collapsed to a single object + # -AsHashtable is closer to raw JSON than PSCustomObject + $suppressions = npm exec --no -- get-suppressions $Tool $Path | ConvertFrom-Json -NoEnumerate -AsHashtable + + if ($LASTEXITCODE -ne 0) { + throw "Failure running 'npm exec get-suppressions'" + } + + return $suppressions; +} + +<# +.DESCRIPTION + Returns the first suppression for a tool applicable to a path. Walks up the directory tree to find all files named + "suppressions.yaml", parses and validates the contents, and returns the first suppression matching the tool and path. + Suppressions are ordered by file (closest to path is first), then within the file (closest to top is first). + +.PARAMETER Tool + Name of tool. Matched against property "tool" in suppressions.yaml. + +.PARAMETER Path + Path to file or directory under analysis. + +.OUTPUTS + Hashtable + First suppressions matching tool and path (may be null). See the "get-suppressions" tool for the definition + of the suppression object. +#> +function Get-Suppression { + param ( + [string]$Tool, + [string]$Path + ) + + $suppressions = @(Get-Suppressions $Tool $Path) + return $suppressions ? $suppressions[0] : $null; +} diff --git a/eng/scripts/TypeSpec-Requirement.ps1 b/eng/scripts/TypeSpec-Requirement.ps1 index b6c38af4a4d1..c7fe5aea5095 100644 --- a/eng/scripts/TypeSpec-Requirement.ps1 +++ b/eng/scripts/TypeSpec-Requirement.ps1 @@ -16,24 +16,14 @@ Set-StrictMode -Version 3 . $PSScriptRoot/ChangedFiles-Functions.ps1 . $PSScriptRoot/Logging-Functions.ps1 +. $PSScriptRoot/Suppressions-Functions.ps1 -function Get-Suppression { +function Get-ValidatedSuppression { param ( [string]$fileInSpecFolder ) - # -NoEnumerate to prevent single-element arrays from being collapsed to a single object - # -AsHashtable is closer to raw JSON than PSCustomObject - $suppressions = npm exec --no -- get-suppressions TypeSpecRequirement $fileInSpecFolder | ConvertFrom-Json -NoEnumerate -AsHashtable - - if ($LASTEXITCODE -ne 0) { - LogError "Failure running 'npm exec get-suppressions'" - LogJobFailure - exit 1 - } - - # For now, we just use the first matching suppression returned by "get-suppressions" (#29003) - $suppression = $suppressions ? $suppressions[0] : $null + $suppression = Get-Suppression "TypeSpecRequirement" $fileInSpecFolder if ($suppression) { # Each path must specify a single version (without wildcards) under "preview|stable" @@ -90,7 +80,7 @@ else { $fullPath = (Join-Path $repoPath $file) - $suppression = Get-Suppression $fullPath + $suppression = Get-ValidatedSuppression $fullPath if ($suppression) { $reason = $suppression["reason"] ?? "" diff --git a/eng/scripts/TypeSpec-Validation.ps1 b/eng/scripts/TypeSpec-Validation.ps1 index 66dadddb2f17..30985a681fb7 100644 --- a/eng/scripts/TypeSpec-Validation.ps1 +++ b/eng/scripts/TypeSpec-Validation.ps1 @@ -2,11 +2,13 @@ param ( [switch]$CheckAll = $false, [switch]$GitClean = $false, + [switch]$DryRun = $false, [string]$BaseCommitish = "HEAD^", [string]$TargetCommitish = "HEAD" ) . $PSScriptRoot/Logging-Functions.ps1 +. $PSScriptRoot/Suppressions-Functions.ps1 $typespecFolders = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" -BaseCommitish:$BaseCommitish -TargetCommitish:$TargetCommitish -CheckAll:$CheckAll @@ -15,7 +17,24 @@ if ($typespecFolders) { $typespecFolders = $typespecFolders.Split('',[System.StringSplitOptions]::RemoveEmptyEntries) foreach ($typespecFolder in $typespecFolders) { LogGroupStart "Validating $typespecFolder" + + if ($CheckAll) { + $suppression = Get-Suppression "TypeSpecValidationAll" $typespecFolder + if ($suppression) { + $reason = $suppression["reason"] ?? "" + LogInfo "Suppressed: $reason" + LogGroupEnd + continue + } + } + LogInfo "npm exec --no -- tsv $typespecFolder" + + if ($DryRun) { + LogGroupEnd + continue + } + npm exec --no -- tsv $typespecFolder 2>&1 | Write-Host if ($LASTEXITCODE) { $typespecFoldersWithFailures += $typespecFolder From e86ca15e0541537724699f91c71d1728f77c3ae8 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Mon, 26 Aug 2024 20:03:57 -0500 Subject: [PATCH 05/30] [TypeSpecValidation] Enable -All pipeline in RPSaaSMaster (#30328) --- eng/pipelines/typespec-validation-all.yml | 3 +++ eng/scripts/ChangedFiles-Functions.ps1 | 3 ++- eng/scripts/Get-TypeSpec-Folders.ps1 | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/eng/pipelines/typespec-validation-all.yml b/eng/pipelines/typespec-validation-all.yml index 9354cc45d7f3..9661bc5d774e 100644 --- a/eng/pipelines/typespec-validation-all.yml +++ b/eng/pipelines/typespec-validation-all.yml @@ -2,12 +2,14 @@ trigger: branches: include: - main + - RPSaaSMaster - typespec-next pr: branches: include: - main + - RPSaaSMaster - typespec-next paths: include: @@ -17,6 +19,7 @@ pr: - package.json - tsconfig.json - eng + - specification/suppressions.yaml - specification/common-types resources: diff --git a/eng/scripts/ChangedFiles-Functions.ps1 b/eng/scripts/ChangedFiles-Functions.ps1 index 074d282ab297..af5ace202fe4 100644 --- a/eng/scripts/ChangedFiles-Functions.ps1 +++ b/eng/scripts/ChangedFiles-Functions.ps1 @@ -42,7 +42,8 @@ function Get-ChangedCoreFiles($changedFiles = (Get-ChangedFiles)) { ".prettierrc.json", "package-lock.json", "package.json", - "tsconfig.json" + "tsconfig.json", + "specification/suppressions.yaml" ) $coreFiles = $changedFiles.Where({ diff --git a/eng/scripts/Get-TypeSpec-Folders.ps1 b/eng/scripts/Get-TypeSpec-Folders.ps1 index 3c4645e408d7..1ddb8ef0fc55 100644 --- a/eng/scripts/Get-TypeSpec-Folders.ps1 +++ b/eng/scripts/Get-TypeSpec-Folders.ps1 @@ -18,7 +18,7 @@ else { $changedFiles = @(Get-ChangedFiles -baseCommitish $BaseCommitish -targetCommitish $TargetCommitish -diffFilter "") $coreChangedFiles = Get-ChangedCoreFiles $changedFiles - if ($Env:BUILD_REPOSITORY_NAME -eq 'azure/azure-rest-api-specs' -and $coreChangedFiles) { + if ($coreChangedFiles) { Write-Verbose "Found changes to core eng or root files so checking all specs." $changedFiles = $checkAllPath } From d85634405ec3b905f1b0bfc350e47cb704aedb61 Mon Sep 17 00:00:00 2001 From: miaxzhitong <146033271+miaxzhitong@users.noreply.github.com> Date: Mon, 26 Aug 2024 18:58:59 -0700 Subject: [PATCH 06/30] [Azure Maps] Update Render Doc (#30245) * add new tilesetid and fix tilesetid related typo * add new tilesetid to static image 20240401 * add pin limit to doc * typo fix * fix typo * typo fix for microsoft.imagery * remove new tilesetid * fix link --- .../maps/data-plane/Render/preview/2.0/render.json | 4 ++-- .../maps/data-plane/Render/stable/2022-08-01/render.json | 4 ++-- .../maps/data-plane/Render/stable/2024-04-01/render.json | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json index 559613f50a63..9f203a5991bb 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -138,7 +138,7 @@ }, { "value": "microsoft.imagery", - "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." + "description": "A combination of satellite or aerial imagery. Only available in S1 and G2 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (png)." }, { "value": "microsoft.weather.radar.main", @@ -146,7 +146,7 @@ }, { "value": "microsoft.weather.infrared.main", - "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." + "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://learn.microsoft.com/azure/azure-maps/weather-services-concepts#satellite-images).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." }, { "value": "microsoft.dem", diff --git a/specification/maps/data-plane/Render/stable/2022-08-01/render.json b/specification/maps/data-plane/Render/stable/2022-08-01/render.json index 45020010edc6..56a17008b354 100644 --- a/specification/maps/data-plane/Render/stable/2022-08-01/render.json +++ b/specification/maps/data-plane/Render/stable/2022-08-01/render.json @@ -218,7 +218,7 @@ }, { "value": "microsoft.imagery", - "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." + "description": "A combination of satellite or aerial imagery. Only available in S1 and G2 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (png)." }, { "value": "microsoft.weather.radar.main", @@ -226,7 +226,7 @@ }, { "value": "microsoft.weather.infrared.main", - "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." + "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://learn.microsoft.com/azure/azure-maps/weather-services-concepts#satellite-images).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." }, { "value": "microsoft.traffic.absolute", diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/render.json b/specification/maps/data-plane/Render/stable/2024-04-01/render.json index 9ae21d4b91f8..1e0d0e976520 100644 --- a/specification/maps/data-plane/Render/stable/2024-04-01/render.json +++ b/specification/maps/data-plane/Render/stable/2024-04-01/render.json @@ -196,7 +196,7 @@ }, { "value": "microsoft.imagery", - "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." + "description": "A combination of satellite or aerial imagery. Only available in S1 and G2 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (png)." }, { "value": "microsoft.weather.radar.main", @@ -204,7 +204,7 @@ }, { "value": "microsoft.weather.infrared.main", - "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. For more information, see [Azure Maps weather services coverage](/azure/azure-maps/weather-coverage). For more information about the satellite data returned, see [Weather services in Azure Maps](/azure-maps/weather-services-concepts#satellite-images).\n\nSupports zoom levels 0 through 15. Format: raster (png)." + "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. For more information, see [Azure Maps weather services coverage](/azure/azure-maps/weather-coverage). For more information about the satellite data returned, see [Weather services in Azure Maps](https://learn.microsoft.com/azure/azure-maps/weather-services-concepts#satellite-images).\n\nSupports zoom levels 0 through 15. Format: raster (png)." }, { "value": "microsoft.traffic.absolute", @@ -638,7 +638,7 @@ }, { "name": "pins", - "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins (in double) and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. Avoid using special character such as `|` or `||` in label. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built-in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. The maximum allowed size for a customized label image is 65,536 pixels. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Type | Range \n:--------:|---------------|--------|----------\nal | Alpha (opacity) | float | 0 to 1 \nan | Pin anchor | | * \nco | Pin color | string | 000000 to FFFFFF \nla | Label anchor | | * \nlc | Label color | string | 000000 to FFFFFF \nls | Label size | float | Greater than 0 \nro | Rotation | float | -360 to 360 \nsc | Scale | float | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", + "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins (in double) and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter and the number of locations is limited to 5 per pin. Other SKUs\nallow up to 25 instances of the pins parameter to specify multiple pin styles, and the number of locations is limited to 50 per pin.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. Avoid using special character such as `|` or `||` in label. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built-in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. The maximum allowed size for a customized label image is 65,536 pixels. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Type | Range \n:--------:|---------------|--------|----------\nal | Alpha (opacity) | float | 0 to 1 \nan | Pin anchor | | * \nco | Pin color | string | 000000 to FFFFFF \nla | Label anchor | | * \nlc | Label color | string | 000000 to FFFFFF \nls | Label size | float | Greater than 0 \nro | Rotation | float | -360 to 360 \nsc | Scale | float | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", "in": "query", "type": "array", "collectionFormat": "multi", From b7a81b9f8e3a7724b29f994f9d68153b48149703 Mon Sep 17 00:00:00 2001 From: Jaskirat Singh <108129510+jaskisin@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:16:30 +0530 Subject: [PATCH 07/30] Workloads SAPVirtualInstance New GA API 2024-09-01 (#30292) * 2024-09-01 API Changes * Update detection model recommendation (#30272) * Adding Stable version for Operations and Readme file changes * add sdk-suppressions.yaml * remove supression to check errors * Revert "remove supression to check errors" This reverts commit 1475d611466a806552137b621105d1eac18ab2ac. --------- Co-authored-by: Jaskirat Singh Co-authored-by: Han Chiang Co-authored-by: Alancere <804873052@qq.com> --- .../examples/2024-09-01/Operations_List.json | 1105 ++++ .../Workloads.Operations.Management/main.tsp | 8 + .../SAPApplicationServerInstance.tsp | 91 + .../SAPCentralServerInstance.tsp | 91 + .../SAPDatabaseInstance.tsp | 90 + .../SAPVirtualInstance.tsp | 129 + .../SAPVirtualInstanceMetadata.tsp | 23 + .../custom.tsp | 36 + .../SapApplicationServerInstances_Create.json | 95 + ...tances_CreateForHaWithAvailabilitySet.json | 130 + .../SapApplicationServerInstances_Delete.json | 23 + .../SapApplicationServerInstances_Get.json | 52 + ...verInstances_ListBySapVirtualInstance.json | 92 + ...licationServerInstances_StartInstance.json | 29 + ...cationServerInstances_StartInstanceVM.json | 31 + ...plicationServerInstances_StopInstance.json | 31 + ...rInstances_StopInstanceInfrastructure.json | 32 + ...ationServerInstances_StopInstanceSoft.json | 31 + ...tances_StopInstanceSoftInfrastructure.json | 32 + .../SapApplicationServerInstances_Update.json | 57 + .../SapCentralInstances_Create.json | 140 + ...tances_CreateForHaWithAvailabilitySet.json | 174 + .../SapCentralInstances_Delete.json | 23 + .../2024-09-01/SapCentralInstances_Get.json | 74 + .../SapCentralInstances_StartInstance.json | 29 + .../SapCentralInstances_StartInstanceVM.json | 31 + .../SapCentralInstances_StopInstance.json | 31 + .../SapCentralInstances_StopInstanceVM.json | 31 + .../SapCentralInstances_Update.json | 79 + ...verInstances_ListBySapVirtualInstance.json | 77 + .../SapDatabaseInstances_Create.json | 80 + ...tances_CreateForHaWithAvailabilitySet.json | 96 + .../SapDatabaseInstances_Delete.json | 23 + .../2024-09-01/SapDatabaseInstances_Get.json | 36 + .../2024-09-01/SapDatabaseInstances_List.json | 47 + .../SapDatabaseInstances_StartInstance.json | 29 + .../SapDatabaseInstances_StartInstanceVM.json | 31 + .../SapDatabaseInstances_StopInstance.json | 31 + ...SapDatabaseInstances_StopInstanceSoft.json | 31 + ...pDatabaseInstances_StopInstanceSoftVM.json | 32 + .../SapDatabaseInstances_StopInstanceVM.json | 32 + .../SapDatabaseInstances_Update.json | 49 + .../SapVirtualInstances_CreateDetectDS.json | 336 ++ ...stances_CreateDetectHaAvailabilitySet.json | 333 ++ ...tances_CreateDetectHaAvailabilityZone.json | 333 ++ ...ualInstances_CreateDetectSingleServer.json | 184 + .../SapVirtualInstances_CreateInfraDS.json | 340 ++ ...tances_CreateInfraDiskOsDSRecommended.json | 454 ++ ...fraDiskOsHaAvailabilitySetRecommended.json | 463 ++ ...raDiskOsHaAvailabilityZoneRecommended.json | 463 ++ ...ateInfraDiskOsSingleServerRecommended.json | 314 + ...nstances_CreateInfraHaAvailabilitySet.json | 349 ++ ...stances_CreateInfraHaAvailabilityZone.json | 349 ++ ...nces_CreateInfraOsComputeGalleryImage.json | 322 + ...es_CreateInfraOsCustomResourceNamesDS.json | 595 ++ ...sCustomResourceNamesHaAvailabilitySet.json | 787 +++ ...CustomResourceNamesHaAvailabilityZone.json | 778 +++ ...nfraOsCustomResourceNamesSingleServer.json | 238 + ...lInstances_CreateInfraOsDSRecommended.json | 316 + ...teInfraOsHaAvailabilitySetRecommended.json | 325 ++ ...eInfraOsHaAvailabilityZoneRecommended.json | 325 ++ ..._CreateInfraOsSIngleServerRecommended.json | 176 + ...tualInstances_CreateInfraSingleServer.json | 172 + ...nces_CreateInfraWithExistingFileshare.json | 337 ++ ...Instances_CreateInfraWithNewFileshare.json | 337 ++ ...tances_CreateInfraWithOsTrustedAccess.json | 319 + ...Instances_CreateInfraWithoutFileshare.json | 331 ++ .../SapVirtualInstances_CreateInstallDS.json | 342 ++ ...alInstances_CreateInstallSingleServer.json | 286 + ...lInstances_CreateRegisterSapSolutions.json | 91 + ...nces_CreateRegisterSapSolutionsCustom.json | 93 + ...ances_CreateRegisterWithTrustedAccess.json | 94 + .../SapVirtualInstances_Delete.json | 22 + .../2024-09-01/SapVirtualInstances_Get.json | 137 + ...lInstances_GetAcssInstallationBlocked.json | 128 + ...ces_GetAvailabilityZoneDetails_eastus.json | 26 + ...etAvailabilityZoneDetails_northeurope.json | 26 + ...stances_GetDiskConfigurations_NonProd.json | 399 ++ ...lInstances_GetDiskConfigurations_Prod.json | 256 + ...tances_GetSapSupportedSku_Distributed.json | 114 + ...etSapSupportedSku_DistributedHA_AvSet.json | 115 + ...tSapSupportedSku_DistributedHA_AvZone.json | 95 + ...ances_GetSapSupportedSku_SingleServer.json | 44 + ...ingRecommendations_S4HANA_Distributed.json | 32 + ...SizingRecommendations_S4HANA_HA_AvSet.json | 33 + ...izingRecommendations_S4HANA_HA_AvZone.json | 33 + ...ngRecommendations_S4HANA_SingleServer.json | 27 + ...pVirtualInstances_ListByResourceGroup.json | 236 + ...apVirtualInstances_ListBySubscription.json | 235 + .../SapVirtualInstances_SoftStop.json | 30 + ...pVirtualInstances_SoftStopVMAndSystem.json | 31 + .../2024-09-01/SapVirtualInstances_Start.json | 30 + ...ualInstances_StartWithInfraOperations.json | 30 + .../2024-09-01/SapVirtualInstances_Stop.json | 30 + .../SapVirtualInstances_StopVMAndSystem.json | 31 + .../SapVirtualInstances_Update.json | 62 + ...pVirtualInstances_UpdateTrustedAccess.json | 65 + .../main.tsp | 44 + .../models.tsp | 2492 ++++++++ .../tspconfig.yaml | 16 + .../SAPVirtualInstance/readme.md | 25 +- .../SAPVirtualInstance/sdk-suppressions.yaml | 59 + .../stable/2024-09-01/SAPVirtualInstance.json | 5163 +++++++++++++++++ .../SapApplicationServerInstances_Create.json | 95 + ...tances_CreateForHaWithAvailabilitySet.json | 130 + .../SapApplicationServerInstances_Delete.json | 23 + .../SapApplicationServerInstances_Get.json | 52 + ...verInstances_ListBySapVirtualInstance.json | 92 + ...licationServerInstances_StartInstance.json | 29 + ...cationServerInstances_StartInstanceVM.json | 31 + ...plicationServerInstances_StopInstance.json | 31 + ...rInstances_StopInstanceInfrastructure.json | 32 + ...ationServerInstances_StopInstanceSoft.json | 31 + ...tances_StopInstanceSoftInfrastructure.json | 32 + .../SapApplicationServerInstances_Update.json | 57 + .../examples/SapCentralInstances_Create.json | 140 + ...tances_CreateForHaWithAvailabilitySet.json | 174 + .../examples/SapCentralInstances_Delete.json | 23 + .../examples/SapCentralInstances_Get.json | 74 + .../SapCentralInstances_StartInstance.json | 29 + .../SapCentralInstances_StartInstanceVM.json | 31 + .../SapCentralInstances_StopInstance.json | 31 + .../SapCentralInstances_StopInstanceVM.json | 31 + .../examples/SapCentralInstances_Update.json | 79 + ...verInstances_ListBySapVirtualInstance.json | 77 + .../examples/SapDatabaseInstances_Create.json | 80 + ...tances_CreateForHaWithAvailabilitySet.json | 96 + .../examples/SapDatabaseInstances_Delete.json | 23 + .../examples/SapDatabaseInstances_Get.json | 36 + .../examples/SapDatabaseInstances_List.json | 47 + .../SapDatabaseInstances_StartInstance.json | 29 + .../SapDatabaseInstances_StartInstanceVM.json | 31 + .../SapDatabaseInstances_StopInstance.json | 31 + ...SapDatabaseInstances_StopInstanceSoft.json | 31 + ...pDatabaseInstances_StopInstanceSoftVM.json | 32 + .../SapDatabaseInstances_StopInstanceVM.json | 32 + .../examples/SapDatabaseInstances_Update.json | 49 + .../SapVirtualInstances_CreateDetectDS.json | 336 ++ ...stances_CreateDetectHaAvailabilitySet.json | 333 ++ ...tances_CreateDetectHaAvailabilityZone.json | 333 ++ ...ualInstances_CreateDetectSingleServer.json | 184 + .../SapVirtualInstances_CreateInfraDS.json | 340 ++ ...tances_CreateInfraDiskOsDSRecommended.json | 454 ++ ...fraDiskOsHaAvailabilitySetRecommended.json | 463 ++ ...raDiskOsHaAvailabilityZoneRecommended.json | 463 ++ ...ateInfraDiskOsSingleServerRecommended.json | 314 + ...nstances_CreateInfraHaAvailabilitySet.json | 349 ++ ...stances_CreateInfraHaAvailabilityZone.json | 349 ++ ...nces_CreateInfraOsComputeGalleryImage.json | 322 + ...es_CreateInfraOsCustomResourceNamesDS.json | 595 ++ ...sCustomResourceNamesHaAvailabilitySet.json | 787 +++ ...CustomResourceNamesHaAvailabilityZone.json | 778 +++ ...nfraOsCustomResourceNamesSingleServer.json | 238 + ...lInstances_CreateInfraOsDSRecommended.json | 316 + ...teInfraOsHaAvailabilitySetRecommended.json | 325 ++ ...eInfraOsHaAvailabilityZoneRecommended.json | 325 ++ ..._CreateInfraOsSIngleServerRecommended.json | 176 + ...tualInstances_CreateInfraSingleServer.json | 172 + ...nces_CreateInfraWithExistingFileshare.json | 337 ++ ...Instances_CreateInfraWithNewFileshare.json | 337 ++ ...tances_CreateInfraWithOsTrustedAccess.json | 319 + ...Instances_CreateInfraWithoutFileshare.json | 331 ++ .../SapVirtualInstances_CreateInstallDS.json | 342 ++ ...alInstances_CreateInstallSingleServer.json | 286 + ...lInstances_CreateRegisterSapSolutions.json | 91 + ...nces_CreateRegisterSapSolutionsCustom.json | 93 + ...ances_CreateRegisterWithTrustedAccess.json | 94 + .../examples/SapVirtualInstances_Delete.json | 22 + .../examples/SapVirtualInstances_Get.json | 137 + ...lInstances_GetAcssInstallationBlocked.json | 128 + ...ces_GetAvailabilityZoneDetails_eastus.json | 26 + ...etAvailabilityZoneDetails_northeurope.json | 26 + ...stances_GetDiskConfigurations_NonProd.json | 399 ++ ...lInstances_GetDiskConfigurations_Prod.json | 256 + ...tances_GetSapSupportedSku_Distributed.json | 114 + ...etSapSupportedSku_DistributedHA_AvSet.json | 115 + ...tSapSupportedSku_DistributedHA_AvZone.json | 95 + ...ances_GetSapSupportedSku_SingleServer.json | 44 + ...ingRecommendations_S4HANA_Distributed.json | 32 + ...SizingRecommendations_S4HANA_HA_AvSet.json | 33 + ...izingRecommendations_S4HANA_HA_AvZone.json | 33 + ...ngRecommendations_S4HANA_SingleServer.json | 27 + ...pVirtualInstances_ListByResourceGroup.json | 236 + ...apVirtualInstances_ListBySubscription.json | 235 + .../SapVirtualInstances_SoftStop.json | 30 + ...pVirtualInstances_SoftStopVMAndSystem.json | 31 + .../examples/SapVirtualInstances_Start.json | 30 + ...ualInstances_StartWithInfraOperations.json | 30 + .../examples/SapVirtualInstances_Stop.json | 30 + .../SapVirtualInstances_StopVMAndSystem.json | 31 + .../examples/SapVirtualInstances_Update.json | 62 + ...pVirtualInstances_UpdateTrustedAccess.json | 65 + .../2024-09-01/examples/Operations_List.json | 1105 ++++ .../stable/2024-09-01/operations.json | 86 + 194 files changed, 39136 insertions(+), 7 deletions(-) create mode 100644 specification/workloads/Workloads.Operations.Management/examples/2024-09-01/Operations_List.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/SAPApplicationServerInstance.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/SAPCentralServerInstance.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/SAPDatabaseInstance.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstance.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstanceMetadata.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/custom.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Create.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Delete.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Get.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_ListBySapVirtualInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstanceVM.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceInfrastructure.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoft.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Update.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Create.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_CreateForHaWithAvailabilitySet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Delete.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Get.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstanceVM.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstanceVM.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Update.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralServerInstances_ListBySapVirtualInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Create.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Delete.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Get.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_List.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstanceVM.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstance.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoft.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoftVM.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceVM.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Update.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectDS.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilitySet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilityZone.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectSingleServer.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDS.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilitySet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilityZone.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsDSRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraSingleServer.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithExistingFileshare.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithNewFileshare.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithoutFileshare.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallDS.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallSingleServer.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutions.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterWithTrustedAccess.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Delete.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Get.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAcssInstallationBlocked.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_NonProd.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_Prod.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_Distributed.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_SingleServer.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListByResourceGroup.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListBySubscription.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStop.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStopVMAndSystem.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Start.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StartWithInfraOperations.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Stop.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StopVMAndSystem.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Update.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_UpdateTrustedAccess.json create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/main.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/sdk-suppressions.yaml create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/SAPVirtualInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Create.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Delete.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Get.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_ListBySapVirtualInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstanceVM.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceInfrastructure.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoft.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Update.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Create.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_CreateForHaWithAvailabilitySet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Delete.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Get.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstanceVM.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstanceVM.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Update.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralServerInstances_ListBySapVirtualInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Create.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Delete.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Get.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_List.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstanceVM.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstance.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoft.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoftVM.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceVM.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Update.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectDS.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilitySet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilityZone.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectSingleServer.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDS.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilitySet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilityZone.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsDSRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraSingleServer.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithExistingFileshare.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithNewFileshare.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithoutFileshare.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallDS.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallSingleServer.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutions.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterWithTrustedAccess.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Delete.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Get.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAcssInstallationBlocked.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_NonProd.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_Prod.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_Distributed.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_SingleServer.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListByResourceGroup.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListBySubscription.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStop.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStopVMAndSystem.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Start.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StartWithInfraOperations.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Stop.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StopVMAndSystem.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Update.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_UpdateTrustedAccess.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/examples/Operations_List.json create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/operations.json diff --git a/specification/workloads/Workloads.Operations.Management/examples/2024-09-01/Operations_List.json b/specification/workloads/Workloads.Operations.Management/examples/2024-09-01/Operations_List.json new file mode 100644 index 000000000000..8bf8d1285ed6 --- /dev/null +++ b/specification/workloads/Workloads.Operations.Management/examples/2024-09-01/Operations_List.json @@ -0,0 +1,1105 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Workloads/RegisteredSubscriptions/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "RegisteredSubscriptions", + "operation": "Gets/Lists registered subscriptions", + "description": "Reads registered subscriptions" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_List", + "description": "Lists WordpressInstances resources under a phpWorkload resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_Get", + "description": "Gets a WordpressInstances resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_CreateOrUpdate", + "description": "Create or updated WordpressInstances resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_Delete", + "description": "Delete WordpressInstances resource" + } + }, + { + "name": "Microsoft.Workloads/skus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Skus", + "operation": "Gets the list of Microsoft.Workloads SKUs available for your Subscription", + "description": "Gets the list of Microsoft.Workloads SKUs available for your Subscription" + } + }, + { + "name": "Microsoft.Workloads/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + }, + { + "name": "Microsoft.Workloads/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Microsoft.Workloads", + "operation": "Register the Microsoft.Workloads", + "description": "Register the subscription for Microsoft.Workloads" + } + }, + { + "name": "Microsoft.Workloads/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Microsoft.Workloads", + "operation": "Unregister the Microsoft.Workloads", + "description": "Unregister the subscription for Microsoft.Workloads" + } + }, + { + "name": "Microsoft.Workloads/Locations/OperationStatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Locations/OperationStatuses", + "operation": "read_OperationStatuses", + "description": "read OperationStatuses" + } + }, + { + "name": "Microsoft.Workloads/Locations/OperationStatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Locations/OperationStatuses", + "operation": "write_OperationStatuses", + "description": "write OperationStatuses" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_ListBySubscription", + "description": "Lists phpWorkload resources in a subscription" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_ListByResourceGroup", + "description": "Lists phpWorkload resources in a resource group" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_Get", + "description": "Gets a phpWorkload resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_CreateOrUpdate", + "description": "Create or updated phpWorkloads resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_Delete", + "description": "Delete phpWorkloads resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_Update", + "description": "Update PHP workload resource." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Get", + "description": "Gets the SAP Application Server Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Create", + "description": "Puts the SAP Application Server Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Delete", + "description": "Deletes the SAP Application Server Instance.

This operation will be used by service only. Delete by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Update", + "description": "Puts the SAP Application Server Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_List", + "description": "Lists the SAP Application server Instances in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_StartInstance", + "description": "Starts the SAP Application server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_StopInstance", + "description": "Stops the SAP Application server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Get", + "description": "Gets the SAP Central Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Create", + "description": "Puts the SAP Central Instance.

This will be used by service only. PUT by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Delete", + "description": "Deletes the SAP Central Instance.

This will be used by service only. Delete by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Update", + "description": "Updates the SAP Central Instance.

This can be used to update tags." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_List", + "description": "Lists the SAP Central Instances in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_StartInstance", + "description": "Starts the SAP Central server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_StopInstance", + "description": "Stops the SAP Central server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Get", + "description": "Gets the SAP Database Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Create", + "description": "Puts the SAP Database Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Delete", + "description": "Deletes the SAP Database Instance.

This will be used by service only. Delete by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Update", + "description": "Puts the SAP Database Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_List", + "description": "Lists the SAP Database Instances in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_StartInstance", + "description": "Starts the database instance of the SAP system." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_StopInstance", + "description": "Stops the database instance of the SAP system." + } + }, + { + "name": "Microsoft.Workloads/monitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_List", + "description": "Gets a list of SAP monitors in the specified subscription. The operations returns various properties of each SAP monitor." + } + }, + { + "name": "Microsoft.Workloads/monitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_ListByResourceGroup", + "description": "Gets a list of SAP monitors in the specified resource group." + } + }, + { + "name": "Microsoft.Workloads/monitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Get", + "description": "Gets properties of a SAP monitor for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Create", + "description": "Creates a SAP monitor for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Delete", + "description": "Deletes a SAP monitor with the specified subscription, resource group, and monitor name." + } + }, + { + "name": "Microsoft.Workloads/monitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Update", + "description": "Patches the Tags field of a SAP monitor for the specified subscription, resource group, and monitor name." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_List", + "description": "Gets a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_Get", + "description": "Gets properties of a provider instance for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_Create", + "description": "Creates a provider instance for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_Delete", + "description": "Deletes a provider instance for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_List", + "description": "Gets a list of alert instances in the specified SAP monitor. The operations returns various properties of each provider instances." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_Get", + "description": "Gets properties of a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_Create", + "description": "Creates a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_Delete", + "description": "Deletes a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alertTemplates/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alertTemplates", + "operation": "AlertTemplates_List", + "description": "Gets properties of an alert template for the specified subscription, resource group, SAP monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alertTemplates/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alertTemplates", + "operation": "AlertTemplates_Get", + "description": "Gets properties of a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_List", + "description": "Gets a list of properties of a SAP Landscape monitor configuration for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_Get", + "description": "Gets properties of a SAP Landscape monitor configuration for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_Create", + "description": "Creates a SAP Landscape monitor configuration for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_Delete", + "description": "Deletes a SAP Landscape monitor configuration with the specified subscription, resource group, and monitor name." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Get", + "description": "Gets an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Create", + "description": "Creates an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Delete", + "description": "Deletes an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Update", + "description": "Updates an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_ListByResourceGroup", + "description": "Gets all SAP Virtual Instances in a resource group." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_ListBySubscription", + "description": "Gets all SAP Virtual Instances in the subscription." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Start", + "description": "Starts the SAP System." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Stop", + "description": "Stops the SAP System." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getSizingRecommendations/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPSizingRecommendations", + "description": "Get SAP sizing recommendations." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getSapSupportedSku/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPSupportedSku", + "description": "Get SAP supported SKUs." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getDiskConfigurations/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPDiskConfigurations", + "description": "Get SAP Disk Configurations." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getAvailabilityZoneDetails/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPAvailabilityZoneDetails", + "description": "Get SAP Availability Zone Details." + } + }, + { + "name": "Microsoft.Workloads/connectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Get", + "description": "Gets a connector resource" + } + }, + { + "name": "Microsoft.Workloads/connectors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Create", + "description": "Creates a connector resource" + } + }, + { + "name": "Microsoft.Workloads/connectors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Delete", + "description": "Deletes a connector resource and its child resources, which are the associated connection resources. All the child resources have to be deleted before deleting the connector resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Update", + "description": "Updates a connector resource" + } + }, + { + "name": "Microsoft.Workloads/connectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_ListByResourceGroup", + "description": "Gets all connector resources in a Resource Group." + } + }, + { + "name": "Microsoft.Workloads/connectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_ListBySubscription", + "description": "Gets all connector resources in a Subscription." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Get", + "description": "Gets the backup connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Create", + "description": "Creates the backup connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Delete", + "description": "Deletes the backup connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Update", + "description": "Updates the backup connection resource of virtual instance for SAP.

This can be used to update tags on the resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_List", + "description": "Lists the backup connection resources of virtual instance for SAP under the given connector resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Get", + "description": "Gets the monitor connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Create", + "description": "Creates the monitor connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Delete", + "description": "Deletes the monitor connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Update", + "description": "Updates the monitor connection resource of virtual instance for SAP.

This can be used to update tags on the resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_List", + "description": "Lists the monitor connection resources of virtual instance for SAP under the given connector resource." + } + }, + { + "name": "Microsoft.Workloads/insights/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Get", + "description": "Gets properties of Workloads Insights instance for the specified subscription, resource group and instance name." + } + }, + { + "name": "Microsoft.Workloads/insights/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_ListByResourceGroup", + "description": "Gets a list of Workloads Insight instances in the specified subscription and resource group. The operations returns various properties of each instance." + } + }, + { + "name": "Microsoft.Workloads/insights/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_List", + "description": "Gets a list of Workloads Insight instances in the specified subscription. The operations returns various properties of each instance." + } + }, + { + "name": "Microsoft.Workloads/insights/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Create", + "description": "Creates a Workloads Insights instance for the specified subscription, resource group, and instance name." + } + }, + { + "name": "Microsoft.Workloads/insights/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Delete", + "description": "Deletes a Workloads Insights instance for the specified subscription, resource group and instance name." + } + }, + { + "name": "Microsoft.Workloads/insights/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Update", + "description": "Patches the Workload Insights instance for the specified subscription, resource group, and instance name." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Get", + "description": "Gets a SAP Migration discovery site resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Create", + "description": "Creates a discovery site for SAP Migration." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Delete", + "description": "Deletes a SAP Migration discovery site resource and its child resources, that is the associated SAP Instances and Server Instances." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Update", + "description": "SAPDiscoverySites_Update." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_ListByResourceGroup", + "description": "Gets all SAP Migration discovery site resources in a Resource Group." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_ListBySubscription", + "description": "Gets all SAP Migration discovery site resources in a Subscription." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/importEntities/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_ImportEntities", + "description": "Import a SAP Migration discovery site resource and it's child resources, that is the SAP instances and Server instances." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Get", + "description": "Gets the SAP Instance resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Create", + "description": "Creates the SAP Instance resource.

This will be used by service only. PUT operation on this resource by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Delete", + "description": "Deletes the SAP Instance resource.

This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the SAP Migration discovery site resource, using the delete operation on it." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Update", + "description": "Updates the SAP Instance resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_List", + "description": "Lists the SAP Instance resources for the given SAP Migration discovery site resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Get", + "description": "Gets the Server Instance resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Create", + "description": "Creates the Server Instance resource.

This will be used by service only. PUT operation on this resource by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Delete", + "description": "Deletes the Server Instance resource.

This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the SAP Migration discovery site resource, using the delete operation on it." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Update", + "description": "Updates the Server Instance resource. This operation on a resource by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_List", + "description": "Lists the Server Instance resources for the given SAP Instance resource." + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/workloads/Workloads.Operations.Management/main.tsp b/specification/workloads/Workloads.Operations.Management/main.tsp index 65861de28054..6d702508ac19 100644 --- a/specification/workloads/Workloads.Operations.Management/main.tsp +++ b/specification/workloads/Workloads.Operations.Management/main.tsp @@ -36,4 +36,12 @@ enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_1) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) v2023_10_01_preview: "2023-10-01-preview", + + /** + * The 2024-09-01 API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + v2024_09_01: "2024-09-01", } diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPApplicationServerInstance.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPApplicationServerInstance.tsp new file mode 100644 index 000000000000..e461a0f8e696 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPApplicationServerInstance.tsp @@ -0,0 +1,91 @@ +import "@typespec/openapi"; +import "./models.tsp"; +import "./SAPVirtualInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Workloads; +/** + * Define the SAP Application Server Instance resource. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@parentResource(SAPVirtualInstance) +model SAPApplicationServerInstance + is TrackedResource { + ...ResourceNameParameter< + Resource = SAPApplicationServerInstance, + KeyName = "applicationInstanceName", + SegmentName = "applicationInstances", + NamePattern = "^.*" + >; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@armResourceOperations +interface SAPApplicationServerInstances { + /** + * Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource. + */ + get is ArmResourceRead; + + /** + * Puts the SAP Application Server Instance resource. <br><br>This will be used by service only. PUT by end user will return a Bad Request error. + */ + create is ArmResourceCreateOrReplaceAsync; + + /** + * Puts the SAP Application Server Instance resource. + */ + @parameterVisibility + update is ArmCustomPatchSync< + SAPApplicationServerInstance, + UpdateSAPApplicationInstanceRequest + >; + + /** + * Deletes the SAP Application Server Instance resource. <br><br>This operation will be used by service only. Delete by end user will return a Bad Request error. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Lists the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource. + */ + list is ArmResourceListByParent; + + /** + * Starts the SAP Application Server Instance. + */ + start is ArmResourceActionAsync< + SAPApplicationServerInstance, + StartRequest, + Foundations.OperationStatusResult + >; + + /** + * Stops the SAP Application Server Instance. + */ + stop is ArmResourceActionAsync< + SAPApplicationServerInstance, + StopRequest, + Foundations.OperationStatusResult + >; +} + +@@doc(SAPApplicationServerInstance.name, + "The name of SAP Application Server instance resource." +); +@@doc(SAPApplicationServerInstances.create::parameters.resource, + "The SAP Application Server Instance resource request body." +); +@@doc(SAPApplicationServerInstances.update::parameters.properties, + "The SAP Application Server Instance resource request body." +); +@@doc(SAPApplicationServerInstances.start::parameters.body, + "SAP Application server instance start request body." +); +@@doc(SAPApplicationServerInstances.stop::parameters.body, + "SAP Application server instance stop request body." +); diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPCentralServerInstance.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPCentralServerInstance.tsp new file mode 100644 index 000000000000..e6c9074140f5 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPCentralServerInstance.tsp @@ -0,0 +1,91 @@ +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./SAPVirtualInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Workloads; +/** + * Define the SAP Central Services Instance resource. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@parentResource(SAPVirtualInstance) +model SAPCentralServerInstance is TrackedResource { + ...ResourceNameParameter< + Resource = SAPCentralServerInstance, + KeyName = "centralInstanceName", + SegmentName = "centralInstances", + NamePattern = "^.*" + >; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@armResourceOperations +interface SAPCentralServerInstances { + /** + * Gets the SAP Central Services Instance resource. + */ + get is ArmResourceRead; + + /** + * Creates the SAP Central Services Instance resource. <br><br>This will be used by service only. PUT operation on this resource by end user will return a Bad Request error. + */ + create is ArmResourceCreateOrReplaceAsync; + + /** + * Updates the SAP Central Services Instance resource. <br><br>This can be used to update tags on the resource. + */ + @parameterVisibility + update is ArmCustomPatchSync< + SAPCentralServerInstance, + UpdateSAPCentralInstanceRequest + >; + + /** + * Deletes the SAP Central Services Instance resource. <br><br>This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the Virtual Instance for SAP solutions resource, using the delete operation on it. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Lists the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource. + */ + list is ArmResourceListByParent; + + /** + * Starts the SAP Central Services Instance. + */ + start is ArmResourceActionAsync< + SAPCentralServerInstance, + StartRequest, + Foundations.OperationStatusResult + >; + + /** + * Stops the SAP Central Services Instance. + */ + stop is ArmResourceActionAsync< + SAPCentralServerInstance, + StopRequest, + Foundations.OperationStatusResult + >; +} + +@@doc(SAPCentralServerInstance.name, + "Central Services Instance resource name string modeled as parameter for auto generation to work correctly." +); +@@doc(SAPCentralServerInstances.create::parameters.resource, + "The SAP Central Services Instance request body." +); +@@doc(SAPCentralServerInstances.update::parameters.properties, + "The SAP Central Services Instance resource request body." +); +@@doc(SAPCentralServerInstances.start::parameters.body, + "SAP Central Services instance start request body." +); +@@doc(SAPCentralServerInstances.stop::parameters.body, + "SAP Central Services instance stop request body." +); diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPDatabaseInstance.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPDatabaseInstance.tsp new file mode 100644 index 000000000000..36a20525056d --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPDatabaseInstance.tsp @@ -0,0 +1,90 @@ +import "@typespec/openapi"; +import "./models.tsp"; +import "./SAPVirtualInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Workloads; +/** + * Define the Database resource. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@parentResource(SAPVirtualInstance) +model SAPDatabaseInstance is TrackedResource { + ...ResourceNameParameter< + Resource = SAPDatabaseInstance, + KeyName = "databaseInstanceName", + SegmentName = "databaseInstances", + NamePattern = "^.*" + >; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@armResourceOperations +interface SAPDatabaseInstances { + /** + * Gets the SAP Database Instance resource. + */ + get is ArmResourceRead; + + /** + * Creates the Database resource corresponding to the Virtual Instance for SAP solutions resource. <br><br>This will be used by service only. PUT by end user will return a Bad Request error. + */ + create is ArmResourceCreateOrReplaceAsync; + + /** + * Updates the Database resource. + */ + @parameterVisibility + update is ArmCustomPatchSync< + SAPDatabaseInstance, + UpdateSAPDatabaseInstanceRequest + >; + + /** + * Deletes the Database resource corresponding to a Virtual Instance for SAP solutions resource. <br><br>This will be used by service only. Delete by end user will return a Bad Request error. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Lists the Database resources associated with a Virtual Instance for SAP solutions resource. + */ + list is ArmResourceListByParent; + + /** + * Starts the database instance of the SAP system. + */ + start is ArmResourceActionAsync< + SAPDatabaseInstance, + StartRequest, + Foundations.OperationStatusResult + >; + + /** + * Stops the database instance of the SAP system. + */ + stop is ArmResourceActionAsync< + SAPDatabaseInstance, + StopRequest, + Foundations.OperationStatusResult + >; +} + +@@doc(SAPDatabaseInstance.name, + "Database resource name string modeled as parameter for auto generation to work correctly." +); +@@doc(SAPDatabaseInstances.create::parameters.resource, + "Request body of Database resource of a SAP system." +); +@@doc(SAPDatabaseInstances.update::parameters.properties, + "Database resource update request body." +); +@@doc(SAPDatabaseInstances.start::parameters.body, + "SAP Database server instance start request body." +); +@@doc(SAPDatabaseInstances.stop::parameters.body, + "Stop request for the database instance of the SAP system." +); diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstance.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstance.tsp new file mode 100644 index 000000000000..9d84a70304d9 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstance.tsp @@ -0,0 +1,129 @@ +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Workloads; +/** + * Define the Virtual Instance for SAP solutions resource. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPVirtualInstance is TrackedResource { + ...ResourceNameParameter< + Resource = SAPVirtualInstance, + KeyName = "sapVirtualInstanceName", + SegmentName = "sapVirtualInstances", + NamePattern = "^[a-zA-Z][a-zA-Z0-9]{2}$" + >; + ...Azure.ResourceManager.ManagedServiceIdentityProperty; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@armResourceOperations +interface SAPVirtualInstances { + /** + * Gets a Virtual Instance for SAP solutions resource + */ + get is ArmResourceRead; + + /** + * Creates a Virtual Instance for SAP solutions (VIS) resource + */ + create is ArmResourceCreateOrReplaceAsync; + + /** + * Updates a Virtual Instance for SAP solutions resource + */ + @parameterVisibility + update is ArmCustomPatchAsync< + SAPVirtualInstance, + UpdateSAPVirtualInstanceRequest + >; + + /** + * Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Gets all Virtual Instances for SAP solutions resources in a Resource Group. + */ + listByResourceGroup is ArmResourceListByParent; + + /** + * Gets all Virtual Instances for SAP solutions resources in a Subscription. + */ + listBySubscription is ArmListBySubscription; + + /** + * Starts the SAP application, that is the Central Services instance and Application server instances. + */ + start is ArmResourceActionAsync< + SAPVirtualInstance, + StartRequest, + Foundations.OperationStatusResult + >; + + /** + * Stops the SAP Application, that is the Application server instances and Central Services instance. + */ + stop is ArmResourceActionAsync< + SAPVirtualInstance, + StopRequest, + Foundations.OperationStatusResult + >; + + /** + * Gets the sizing recommendations. + */ + getSizingRecommendations is VirtualResourceActionSync< + SAPVirtualInstanceMetadata, + SAPSizingRecommendationRequest, + SAPSizingRecommendationResult + >; + + /** + * Get a list of SAP supported SKUs for ASCS, Application and Database tier. + */ + getSapSupportedSku is VirtualResourceActionSync< + SAPVirtualInstanceMetadata, + SAPSupportedSkusRequest, + SAPSupportedResourceSkusResult + >; + + /** + * Get the SAP Disk Configuration Layout prod/non-prod SAP System. + */ + getDiskConfigurations is VirtualResourceActionSync< + SAPVirtualInstanceMetadata, + SAPDiskConfigurationsRequest, + SAPDiskConfigurationsResult + >; + + /** + * Get the recommended SAP Availability Zone Pair Details for your region. + */ + getAvailabilityZoneDetails is VirtualResourceActionSync< + SAPVirtualInstanceMetadata, + SAPAvailabilityZoneDetailsRequest, + SAPAvailabilityZoneDetailsResult + >; +} + +@@doc(SAPVirtualInstance.name, + "The name of the Virtual Instances for SAP solutions resource" +); +@@doc(SAPVirtualInstances.create::parameters.resource, + "Virtual Instance for SAP solutions resource request body." +); +@@doc(SAPVirtualInstances.update::parameters.properties, + "Request body to update a Virtual Instance for SAP solutions resource." +); +@@doc(SAPVirtualInstances.start::parameters.body, + "The Virtual Instance for SAP solutions resource start request body." +); +@@doc(SAPVirtualInstances.stop::parameters.body, + "The Virtual Instance for SAP solutions resource stop request body." +); diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstanceMetadata.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstanceMetadata.tsp new file mode 100644 index 000000000000..001341e013ef --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/SAPVirtualInstanceMetadata.tsp @@ -0,0 +1,23 @@ +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.ResourceManager; + +namespace Microsoft.Workloads; + +/** + * The SAP Virtual Instance Metadata. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@singleton +@parentResource(SubscriptionLocationResource) +@armVirtualResource +model SAPVirtualInstanceMetadata { + /** + * The default variable. + */ + @path + @visibility("read") + @segment("sapVirtualInstanceMetadata") + @key + default: "string"; +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/custom.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/custom.tsp new file mode 100644 index 000000000000..2c01f681fe83 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/custom.tsp @@ -0,0 +1,36 @@ +using Http; +using Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; + +/** + * A synchronous resource action. + * @template Resource The resource being acted upon + * @template Request The request model for the action + * @template Response The response model for the action + * @template BaseParameters Optional. Allows overriding the parameters for the operation + * @template Parameters Optional. Additional parameters after the path parameters + * @template Error Optional. The error response, if non-standard. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "Custom template" +// THIS IS TO PROVIDE a temp workaround. The standard ArmResourceXX operations will be expected to support +// ARM virtual resources. Until then, use this custom template +@autoRoute +@armResourceAction(Resource) +@post +@returnsDoc("Azure operation completed successfully.") +op VirtualResourceActionSync< + Resource extends Foundations.Resource, + Request extends TypeSpec.Reflection.Model | void, + Response extends TypeSpec.Reflection.Model | void, + BaseParameters = DefaultBaseParameters, + Parameters extends {} = {}, + Error extends {} = ErrorResponse +>( + ...ResourceInstanceParameters, + ...Parameters, + + @doc("The content of the action request") + @bodyRoot + body: Request, +): Response | Error; diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Create.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Create.json new file mode 100644 index 000000000000..c86c63c9904f --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Unknown", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Create", + "title": "SAPApplicationServerInstances_Create" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json new file mode 100644 index 000000000000..b5826dc6bf76 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Standby", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Unknown", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Standby", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Create", + "title": "Create SAP Application Server Instances for HA System with Availability Set" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Delete.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Delete.json new file mode 100644 index 000000000000..4d69aaa1d07f --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapApplicationServerInstances_Delete", + "title": "SAPApplicationServerInstances_Delete" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Get.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Get.json new file mode 100644 index 000000000000..90416e6235ce --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Get", + "title": "SAPApplicationServerInstances_Get" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_ListBySapVirtualInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_ListBySapVirtualInstance.json new file mode 100644 index 000000000000..f1d7b89e1a35 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_ListBySapVirtualInstance.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "app02", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app02", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapApplicationServerInstances_List", + "title": "SapApplicationServerInstances List By SAP Virtual Instance" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstance.json new file mode 100644 index 000000000000..2894df1f0e30 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Start", + "title": "Start the SAP Application Server Instance." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstanceVM.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstanceVM.json new file mode 100644 index 000000000000..0cd280b57a6e --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StartInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "startVm": true + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Start", + "title": "Start Virtual Machine and the SAP Application Server Instance on it." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstance.json new file mode 100644 index 000000000000..7024658de872 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstance.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Stop the SAP Application Server Instance" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceInfrastructure.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceInfrastructure.json new file mode 100644 index 000000000000..601efcb3619f --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceInfrastructure.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Stop the SAP Application Server Instance and it's infrastructure." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoft.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoft.json new file mode 100644 index 000000000000..8f6a47005e78 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoft.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Soft Stop the SAP Application Server Instance" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json new file mode 100644 index 000000000000..f17a194f9843 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Soft Stop the SAP Application Server Instance and it's infrastructure." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Update.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Update.json new file mode 100644 index 000000000000..eb6613685f98 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapApplicationServerInstances_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "properties": { + "tags": { + "tag1": "value1" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Update", + "title": "SAPApplicationServerInstances_Update" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Create.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Create.json new file mode 100644 index 000000000000..5e5f15aeb0a4 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Create.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Create", + "title": "SapCentralServerInstances_Create" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_CreateForHaWithAvailabilitySet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_CreateForHaWithAvailabilitySet.json new file mode 100644 index 000000000000..d623a14b4172 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_CreateForHaWithAvailabilitySet.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-ASCS-loadBalancer" + }, + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-ASCS-loadBalancer" + }, + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Create", + "title": "Create SAP Central Instances for HA System with Availability Set" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Delete.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Delete.json new file mode 100644 index 000000000000..35d8936d385f --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapCentralServerInstances_Delete", + "title": "SapCentralServerInstances_Delete" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Get.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Get.json new file mode 100644 index 000000000000..467031c34804 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Unknown", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Degraded", + "port": 3300 + }, + "health": "Unknown", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Unhealthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Get", + "title": "SapCentralServerInstances_Get" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstance.json new file mode 100644 index 000000000000..a9890d000e37 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Start", + "title": "Start the SAP Central Services Instance" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstanceVM.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstanceVM.json new file mode 100644 index 000000000000..94931a5fc984 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StartInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "startVm": true + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Start", + "title": "Start the virtual machine(s) and the SAP central services instance on it." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstance.json new file mode 100644 index 000000000000..9ced949f11cc --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstance.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 1200 + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Stop", + "title": "Stop the SAP Central Services Instance." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstanceVM.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstanceVM.json new file mode 100644 index 000000000000..2a78cdfe9321 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_StopInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Stop", + "title": "Stop the SAP Central Services Instance and its underlying Virtual Machine(s)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Update.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Update.json new file mode 100644 index 000000000000..3e3132fd30eb --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralInstances_Update.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "tags": { + "tag1": "value1" + } + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Update", + "title": "SapCentralServerInstances_Update" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralServerInstances_ListBySapVirtualInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralServerInstances_ListBySapVirtualInstance.json new file mode 100644 index 000000000000..1f651e0c89cd --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapCentralServerInstances_ListBySapVirtualInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapCentralServerInstances_List", + "title": "SAPCentralInstances List by SAP virtual instance" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Create.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Create.json new file mode 100644 index 000000000000..1e6cdc400ce3 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Create.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Create", + "title": "SAPDatabaseInstances_Create" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json new file mode 100644 index 000000000000..261d1bcc0b79 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/db-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/db-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Create", + "title": "Create SAP Database Instances for HA System with Availability Set" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Delete.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Delete.json new file mode 100644 index 000000000000..93f99f8c9e52 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapDatabaseInstances_Delete", + "title": "SAPDatabaseInstances_Delete" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Get.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Get.json new file mode 100644 index 000000000000..b5a26695c3ec --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Get", + "title": "SAPDatabaseInstances_Get" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_List.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_List.json new file mode 100644 index 000000000000..4c3f12d64c0a --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapDatabaseInstances_List", + "title": "SAPDatabaseInstances list by SAP virtual instance" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstance.json new file mode 100644 index 000000000000..6232f364c6b8 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Start", + "title": "Start the database instance of the SAP system." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstanceVM.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstanceVM.json new file mode 100644 index 000000000000..94f795130ab8 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StartInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "startVm": true + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Start", + "title": "Start Virtual Machine and the database instance of the SAP system on it." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstance.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstance.json new file mode 100644 index 000000000000..745b05662962 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstance.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 0 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Stop the database instance of the SAP system." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoft.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoft.json new file mode 100644 index 000000000000..1f12bbc33403 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoft.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 300 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Soft Stop the database instance of the SAP system." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoftVM.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoftVM.json new file mode 100644 index 000000000000..7dc4e5d7caad --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceSoftVM.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 300 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Soft Stop the database instance of the SAP system and the underlying Virtual Machine(s)." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceVM.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceVM.json new file mode 100644 index 000000000000..0663f34f7568 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_StopInstanceVM.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 0 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Stop the database instance of the SAP system and the underlying Virtual Machine(s)." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Update.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Update.json new file mode 100644 index 000000000000..78ae2e523795 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapDatabaseInstances_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "tags": { + "key1": "value1" + } + }, + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Update", + "title": "SAPDatabaseInstances_Update" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectDS.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectDS.json new file mode 100644 index 000000000000..55660e83bfeb --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectDS.json @@ -0,0 +1,336 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "{{resourcegrp}}", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": { + "created by": "azureuser" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + }, + "201": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on a Distributed System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilitySet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilitySet.json new file mode 100644 index 000000000000..f3c3389371e1 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilitySet.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on an HA System with Availability Set" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilityZone.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilityZone.json new file mode 100644 index 000000000000..14c52ae8f652 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectHaAvailabilityZone.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on an HA System with Availability Zone" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectSingleServer.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectSingleServer.json new file mode 100644 index 000000000000..49bbc416b82c --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateDetectSingleServer.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "NonProd", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "NonProd", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on a Single Server System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDS.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDS.json new file mode 100644 index 000000000000..a766e5cf0b3d --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDS.json @@ -0,0 +1,340 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for Distributed System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json new file mode 100644 index 000000000000..aa5ffd70e77a --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json @@ -0,0 +1,454 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configuration for Distributed System (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json new file mode 100644 index 000000000000..7331c3e6f9ed --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configuration for HA System with Availability Set (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json new file mode 100644 index 000000000000..73abfbed0309 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configuration for HA System with Availability Zone (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json new file mode 100644 index 000000000000..1efe1d3bef00 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json @@ -0,0 +1,314 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "dbDiskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "dbDiskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "dbDiskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configurations for Single Server System (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilitySet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilitySet.json new file mode 100644 index 000000000000..1ace22d66093 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilitySet.json @@ -0,0 +1,349 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 5, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 5, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 5, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for HA System with Availability Set" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilityZone.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilityZone.json new file mode 100644 index 000000000000..6a88cad4b1bc --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraHaAvailabilityZone.json @@ -0,0 +1,349 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for HA System with Availability Zone" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json new file mode 100644 index 000000000000..a935024adffd --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json @@ -0,0 +1,322 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with Azure Compute Gallery Image" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json new file mode 100644 index 000000000000..63344cdac2c8 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json @@ -0,0 +1,595 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "ascsdisk0" + ] + }, + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + } + ] + }, + "databaseServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "dbhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbnic" + } + ], + "osDiskName": "dbosdisk", + "vmName": "dbvm" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "ascsdisk0" + ] + }, + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + } + ] + }, + "databaseServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "dbhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbnic" + } + ], + "osDiskName": "dbosdisk", + "vmName": "dbvm" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "ascsdisk0" + ] + }, + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + } + ] + }, + "databaseServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "dbhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbnic" + } + ], + "osDiskName": "dbosdisk", + "vmName": "dbvm" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for Distributed System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json new file mode 100644 index 000000000000..62f953099f46 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json @@ -0,0 +1,787 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "availabilitySetName": "csAvSet", + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "availabilitySetName": "dbAvSet", + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "availabilitySetName": "csAvSet", + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "availabilitySetName": "dbAvSet", + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "availabilitySetName": "csAvSet", + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "availabilitySetName": "dbAvSet", + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for HA System with Availability Set" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json new file mode 100644 index 000000000000..24a4e153d02c --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json @@ -0,0 +1,778 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for HA system with Availability Zone" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json new file mode 100644 index 000000000000..be5450a3c29a --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "customResourceNames": { + "namingPatternType": "FullResourceName", + "virtualMachine": { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "sshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ssnic" + } + ], + "osDiskName": "ssosdisk", + "vmName": "ssvm" + } + }, + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "customResourceNames": { + "namingPatternType": "FullResourceName", + "virtualMachine": { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "sshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ssnic" + } + ], + "osDiskName": "ssosdisk", + "vmName": "ssvm" + } + }, + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for Single Server System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsDSRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsDSRecommended.json new file mode 100644 index 000000000000..e2fa771bb6a1 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsDSRecommended.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for Distributed System (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json new file mode 100644 index 000000000000..7b1fea25a9c7 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for HA System with Availability Set (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json new file mode 100644 index 000000000000..388c4e6ac966 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for HA System with Availability Zone (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json new file mode 100644 index 000000000000..0feb3c816304 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for Single Server System (Recommended)" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraSingleServer.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraSingleServer.json new file mode 100644 index 000000000000..b9a00965e79a --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraSingleServer.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for Single Server System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithExistingFileshare.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithExistingFileshare.json new file mode 100644 index 000000000000..e5a4df97ac3b --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithExistingFileshare.json @@ -0,0 +1,337 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Mount", + "id": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint", + "privateEndpointId": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Mount", + "id": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint", + "privateEndpointId": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Mount", + "id": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint", + "privateEndpointId": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with an existing SAP Transport Directory Fileshare" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithNewFileshare.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithNewFileshare.json new file mode 100644 index 000000000000..f852f967dfa3 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithNewFileshare.json @@ -0,0 +1,337 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "CreateAndMount", + "resourceGroup": "rgName", + "storageAccountName": "storageName" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "CreateAndMount", + "resourceGroup": "rgName", + "storageAccountName": "storageName" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "CreateAndMount", + "resourceGroup": "rgName", + "storageAccountName": "storageName" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with a new SAP Transport Directory Fileshare" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json new file mode 100644 index 000000000000..4cf2197240eb --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json @@ -0,0 +1,319 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "managedResourcesNetworkAccessType": "Private", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with trusted access enabled" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithoutFileshare.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithoutFileshare.json new file mode 100644 index 000000000000..72c3952d125e --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInfraWithoutFileshare.json @@ -0,0 +1,331 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Skip" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Skip" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Skip" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure without a SAP Transport Directory Fileshare" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallDS.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallDS.json new file mode 100644 index 000000000000..0f581f2b6cb4 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallDS.json @@ -0,0 +1,342 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "{{resourcegrp}}", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "8.2", + "version": "8.2.2021091201" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "8.2", + "version": "8.2.2021091201" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "8.2", + "version": "8.2.2021091201" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": { + "created by": "azureuser" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + }, + "201": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Install SAP Software on Distributed System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallSingleServer.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallSingleServer.json new file mode 100644 index 000000000000..3e913f151d06 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateInstallSingleServer.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "test-rg", + "deploymentType": "SingleServer", + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/testsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "SLES-SAP", + "publisher": "SUSE", + "sku": "12-sp4-gen2", + "version": "2022.02.01" + }, + "osProfile": { + "adminUsername": "azureappadmin", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + }, + "201": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Install SAP Software on Single Server System" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutions.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutions.json new file mode 100644 index 000000000000..830b22a20690 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutions.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": { + "createdby": "abc@microsoft.com", + "test": "abc" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Register existing SAP system as Virtual Instance for SAP solutions." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json new file mode 100644 index 000000000000..89216ee342fd --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "configurationType": "Discovery", + "managedRgStorageAccountName": "q20saacssgrs" + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": { + "createdby": "abc@microsoft.com", + "test": "abc" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery", + "managedRgStorageAccountName": "q20saacssgrs" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery", + "managedRgStorageAccountName": "q20saacssgrs" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Register existing SAP system as Virtual Instance for SAP solutions with optional customizations." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterWithTrustedAccess.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterWithTrustedAccess.json new file mode 100644 index 000000000000..a30b79a171fe --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_CreateRegisterWithTrustedAccess.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "managedResourcesNetworkAccessType": "Private", + "sapProduct": "S4HANA" + }, + "tags": { + "createdby": "abc@microsoft.com", + "test": "abc" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Register with trusted access enabled" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Delete.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Delete.json new file mode 100644 index 000000000000..c175b7aa8943 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2024-09-01" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2024-09-01" + } + } + }, + "operationId": "SapVirtualInstances_Delete", + "title": "SAPVirtualInstances_Delete" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Get.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Get.json new file mode 100644 index 000000000000..3ce8b6fd611b --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Get.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Get", + "title": "SAPVirtualInstances_Get" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAcssInstallationBlocked.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAcssInstallationBlocked.json new file mode 100644 index 000000000000..b00f314b5cfc --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAcssInstallationBlocked.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "ACSSInstallationBlocked", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Get", + "title": "SAPVirtualInstances Get With ACSS Installation Blocked" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json new file mode 100644 index 000000000000..74cea9033f66 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "eastus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "databaseType": "HANA" + } + }, + "responses": { + "200": { + "body": { + "availabilityZonePairs": [ + { + "zoneA": 1, + "zoneB": 2 + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetAvailabilityZoneDetails", + "title": "SAP Availability zone details in east us" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json new file mode 100644 index 000000000000..80a4687a70cb --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "northeurope", + "api-version": "2024-09-01", + "body": { + "appLocation": "northeurope", + "sapProduct": "S4HANA", + "databaseType": "HANA" + } + }, + "responses": { + "200": { + "body": { + "availabilityZonePairs": [ + { + "zoneA": 2, + "zoneB": 3 + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetAvailabilityZoneDetails", + "title": "SAP Availability zone details in north europe" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_NonProd.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_NonProd.json new file mode 100644 index 000000000000..f46c7b7b19d3 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_NonProd.json @@ -0,0 +1,399 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "NonProd", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "dbVmSku": "Standard_M32ts" + } + }, + "responses": { + "200": { + "body": { + "volumeConfigurations": { + "hana/data": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 4, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 4, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/log": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 3, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 3, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/shared": { + "recommendedConfiguration": { + "sku": { + "name": "StandardSSD_LRS" + }, + "count": 1, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 1024, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 5000, + "mbpsReadWrite": 200, + "diskTier": "P30" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 2048, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P40" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 4096, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P50" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E15" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E20" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 1024, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E30" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 2048, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E40" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 4096, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E50" + } + ] + }, + "usr/sap": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E15" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E20" + } + ] + }, + "os": { + "recommendedConfiguration": { + "sku": { + "name": "StandardSSD_LRS" + }, + "count": 1, + "sizeGB": 64 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 64, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 240, + "mbpsReadWrite": 50, + "diskTier": "P6" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 64, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "P6" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "P10" + } + ] + }, + "backup": { + "recommendedConfiguration": { + "sku": { + "name": "StandardSSD_LRS" + }, + "count": 2, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E15" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E20" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + } + ] + } + } + } + } + }, + "operationId": "SapVirtualInstances_GetDiskConfigurations", + "title": "SAP disk configurations for input environment NonProd." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_Prod.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_Prod.json new file mode 100644 index 000000000000..ddedd6c7439a --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetDiskConfigurations_Prod.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "dbVmSku": "Standard_M32ts" + } + }, + "responses": { + "200": { + "body": { + "volumeConfigurations": { + "hana/data": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 4, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 4, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/log": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 3, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 3, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/shared": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 1024, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 5000, + "mbpsReadWrite": 200, + "diskTier": "P30" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 2048, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P40" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 4096, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P50" + } + ] + }, + "usr/sap": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P10" + } + ] + }, + "os": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 64 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 64, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 240, + "mbpsReadWrite": 50, + "diskTier": "P6" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "backup": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 2, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + } + ] + } + } + } + } + }, + "operationId": "SapVirtualInstances_GetDiskConfigurations", + "title": "SAP disk configurations for input environment Prod." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_Distributed.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_Distributed.json new file mode 100644 index 000000000000..2fb1797f38e3 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_Distributed.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E4ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E8ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E16ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E20ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208s_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416s_v2" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported SKUs for distributed Non HA environment." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json new file mode 100644 index 000000000000..2b3e3084b9bc --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "highAvailabilityType": "AvailabilitySet" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E4ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E8ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E16ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E20ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208s_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416s_v2" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported SKUs for distributed HA environment with Availability set." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json new file mode 100644 index 000000000000..a93c6a800cb8 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "highAvailabilityType": "AvailabilityZone" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M32Is" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M64Is" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M64ms" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M64s" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M128ms" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M128s" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M208ms_v2" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M208s_v2" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M416ms_v2" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M416s_v2" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported Skus for HA with availability zone." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_SingleServer.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_SingleServer.json new file mode 100644 index 000000000000..e2f229190732 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSapSupportedSku_SingleServer.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "NonProd", + "databaseType": "HANA", + "deploymentType": "SingleServer" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported SKUs for single server." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json new file mode 100644 index 000000000000..8b1904344d0c --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "Prod", + "sapProduct": "S4HANA", + "deploymentType": "ThreeTier", + "saps": 20000, + "dbMemory": 1024, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp" + } + }, + "responses": { + "200": { + "body": { + "deploymentType": "ThreeTier", + "applicationServerVmSku": "Standard_E8ds_v4", + "applicationServerInstanceCount": 2, + "centralServerVmSku": "Standard_E4ds_v4", + "centralServerInstanceCount": 1, + "dbVmSku": "Standard_M64s", + "databaseInstanceCount": 1 + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for non HA distributed system." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json new file mode 100644 index 000000000000..2bbf4abd5ba4 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "Prod", + "sapProduct": "S4HANA", + "deploymentType": "ThreeTier", + "saps": 75000, + "dbMemory": 1024, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp", + "highAvailabilityType": "AvailabilitySet" + } + }, + "responses": { + "200": { + "body": { + "deploymentType": "ThreeTier", + "applicationServerVmSku": "Standard_E16ds_v4", + "applicationServerInstanceCount": 3, + "centralServerVmSku": "Standard_E8ds_v4", + "centralServerInstanceCount": 2, + "dbVmSku": "Standard_M64s", + "databaseInstanceCount": 2 + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for HA with availability set." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json new file mode 100644 index 000000000000..c0c92f394636 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "Prod", + "sapProduct": "S4HANA", + "deploymentType": "ThreeTier", + "saps": 75000, + "dbMemory": 1024, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp", + "highAvailabilityType": "AvailabilityZone" + } + }, + "responses": { + "200": { + "body": { + "deploymentType": "ThreeTier", + "applicationServerVmSku": "Standard_E8ds_v4", + "applicationServerInstanceCount": 6, + "centralServerVmSku": "Standard_E4ds_v4", + "centralServerInstanceCount": 2, + "dbVmSku": "Standard_M64s", + "databaseInstanceCount": 2 + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for HA with availability zone." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json new file mode 100644 index 000000000000..d55925c9a9e9 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "NonProd", + "sapProduct": "S4HANA", + "deploymentType": "SingleServer", + "saps": 60000, + "dbMemory": 2000, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp" + } + }, + "responses": { + "200": { + "body": { + "vmSku": "Standard_M128s", + "deploymentType": "SingleServer" + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for single server." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListByResourceGroup.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..03ba0304fb72 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListByResourceGroup.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "X01", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X01", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapVirtualInstances_ListByResourceGroup", + "title": "SAPVirtualInstances_ListByResourceGroup" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListBySubscription.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListBySubscription.json new file mode 100644 index 000000000000..1a5309669175 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_ListBySubscription.json @@ -0,0 +1,235 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "X01", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X01", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapVirtualInstances_ListBySubscription", + "title": "SAPVirtualInstances_ListBySubscription" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStop.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStop.json new file mode 100644 index 000000000000..099319582397 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStop.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "Soft Stop of SapVirtualInstances_Stop" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStopVMAndSystem.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStopVMAndSystem.json new file mode 100644 index 000000000000..4da11118564f --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_SoftStopVMAndSystem.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "Soft Stop the virtual machine(s) and the SAP system on it." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Start.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Start.json new file mode 100644 index 000000000000..82eb7f1824e4 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Start.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": { + "startVm": true + } + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Start", + "title": "SAPVirtualInstances_Start" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StartWithInfraOperations.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StartWithInfraOperations.json new file mode 100644 index 000000000000..f5a6ccadbea7 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StartWithInfraOperations.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "startVm": true + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Start", + "title": "SAPVirtualInstances_Start_WithInfraOperations" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Stop.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Stop.json new file mode 100644 index 000000000000..9a5cbdfc41f6 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Stop.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "SAPVirtualInstances_Stop" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StopVMAndSystem.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StopVMAndSystem.json new file mode 100644 index 000000000000..6aacadb61cba --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_StopVMAndSystem.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "Stop the virtual machine(s) and the SAP system on it." +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Update.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Update.json new file mode 100644 index 000000000000..dd1845462b78 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "identity": { + "type": "None" + }, + "properties": {}, + "tags": { + "key1": "svi1" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "identity": { + "type": "None" + }, + "location": "westcentralus", + "properties": { + "configuration": { + "configurationType": "Deployment" + }, + "environment": "Prod", + "health": "Unknown", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentPending", + "status": "Starting" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "svi1" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Update", + "title": "SAPVirtualInstances_Update" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_UpdateTrustedAccess.json b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_UpdateTrustedAccess.json new file mode 100644 index 000000000000..bad979d054ef --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/examples/2024-09-01/SapVirtualInstances_UpdateTrustedAccess.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "identity": { + "type": "None" + }, + "properties": { + "managedResourcesNetworkAccessType": "Private" + }, + "tags": { + "key1": "svi1" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "identity": { + "type": "None" + }, + "location": "westcentralus", + "properties": { + "configuration": { + "configurationType": "Deployment" + }, + "environment": "Prod", + "health": "Unknown", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentPending", + "status": "Starting" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "svi1" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Update", + "title": "SAPVirtualInstances_TrustedAccessEnable_Update" +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/main.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/main.tsp new file mode 100644 index 000000000000..9bcea1409344 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/main.tsp @@ -0,0 +1,44 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Version: 0.8.2 + * Date: 2024-07-19T09:05:09.898Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./SAPVirtualInstance.tsp"; +import "./SAPCentralServerInstance.tsp"; +import "./SAPDatabaseInstance.tsp"; +import "./SAPApplicationServerInstance.tsp"; +import "./SAPVirtualInstanceMetadata.tsp"; +import "./custom.tsp"; + +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * Workloads client provides access to various workload operations. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" +@armProviderNamespace +@service({ + title: "Workloads Client", +}) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.Workloads; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2024-09-01 API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_09_01: "2024-09-01", +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp new file mode 100644 index 000000000000..06985787cb05 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp @@ -0,0 +1,2492 @@ +import "@typespec/http"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ResourceManager.CommonTypes; + +namespace Microsoft.Workloads; + +/** + * Defines the environment type - Production/Non Production. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPEnvironmentType { + string, + + /** + * Non Production SAP system. + */ + NonProd: "NonProd", + + /** + * Production SAP system. + */ + Prod: "Prod", +} + +/** + * Defines the SAP Product type. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPProductType { + string, + + /** + * SAP Product ECC. + */ + ECC: "ECC", + + /** + * SAP Product S4HANA. + */ + S4HANA: "S4HANA", + + /** + * SAP Products other than the ones listed. + */ + Other: "Other", +} + +/** + * The type of SAP deployment, single server or Three tier. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPDeploymentType { + string, + + /** + * SAP Single server deployment type. + */ + SingleServer: "SingleServer", + + /** + * SAP Distributed deployment type. + */ + ThreeTier: "ThreeTier", +} + +/** + * Defines the supported SAP Database types. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPDatabaseType { + string, + + /** + * HANA Database type of SAP system. + */ + HANA: "HANA", + + /** + * DB2 database type of the SAP system. + */ + DB2: "DB2", +} + +/** + * The database scale method. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPDatabaseScaleMethod { + string, + + /** + * ScaleUp Hana Database deployment type + */ + ScaleUp: "ScaleUp", +} + +/** + * The high availability type (AvailabilitySet or AvailabilityZone). + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPHighAvailabilityType { + string, + + /** + * HA deployment with availability sets. + */ + AvailabilitySet: "AvailabilitySet", + + /** + * HA deployment with availability zones. + */ + AvailabilityZone: "AvailabilityZone", +} + +/** + * Defines the disk sku name. + */ +union DiskSkuName { + string, + + /** + * Standard LRS Disk SKU. + */ + Standard_LRS: "Standard_LRS", + + /** + * Premium_LRS Disk SKU. + */ + Premium_LRS: "Premium_LRS", + + /** + * StandardSSD_LRS Disk SKU. + */ + StandardSSD_LRS: "StandardSSD_LRS", + + /** + * UltraSSD_LRS Disk SKU. + */ + UltraSSD_LRS: "UltraSSD_LRS", + + /** + * Premium_ZRS Disk SKU. + */ + Premium_ZRS: "Premium_ZRS", + + /** + * StandardSSD_ZRS Disk SKU. + */ + StandardSSD_ZRS: "StandardSSD_ZRS", + + /** + * PremiumV2_LRS Disk SKU. + */ + PremiumV2_LRS: "PremiumV2_LRS", +} + +/** + * Defines the network access type for managed resources. + */ +union ManagedResourcesNetworkAccessType { + string, + + /** + * Managed resources will be deployed with public network access enabled. + */ + Public: "Public", + + /** + * Managed resources will be deployed with public network access disabled. + */ + Private: "Private", +} + +/** + * The configuration Type. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPConfigurationType { + string, + + /** + * SAP system will be deployed by service. No OS configurations will be done. + */ + Deployment: "Deployment", + + /** + * Existing SAP system will be registered. + */ + Discovery: "Discovery", + + /** + * SAP system will be deployed by service. OS configurations will be done. + */ + DeploymentWithOSConfig: "DeploymentWithOSConfig", +} + +/** + * Defines the SAP Instance status. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPVirtualInstanceStatus { + string, + + /** + * SAP system is getting started. + */ + Starting: "Starting", + + /** + * SAP system is running. + */ + Running: "Running", + + /** + * SAP system is being stopped. + */ + Stopping: "Stopping", + + /** + * SAP system is offline. + */ + Offline: "Offline", + + /** + * SAP system is partially running. + */ + PartiallyRunning: "PartiallyRunning", + + /** + * SAP system status is unavailable. + */ + Unavailable: "Unavailable", + + /** + * Soft shutdown of SAP system is initiated. + */ + SoftShutdown: "SoftShutdown", +} + +/** + * Defines the health of SAP Instances. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPHealthState { + string, + + /** + * SAP System health is unknown. + */ + Unknown: "Unknown", + + /** + * SAP System health is healthy. + */ + Healthy: "Healthy", + + /** + * SAP System is unhealthy. + */ + Unhealthy: "Unhealthy", + + /** + * SAP System health is degraded. + */ + Degraded: "Degraded", +} + +/** + * Defines the Virtual Instance for SAP state. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPVirtualInstanceState { + string, + + /** + * Infrastructure is not yet deployed. + */ + InfrastructureDeploymentPending: "InfrastructureDeploymentPending", + + /** + * Infrastructure deployment is in progress. + */ + InfrastructureDeploymentInProgress: "InfrastructureDeploymentInProgress", + + /** + * Infrastructure deployment has failed. + */ + InfrastructureDeploymentFailed: "InfrastructureDeploymentFailed", + + /** + * Infrastructure deployment is successful. Software installation is pending. + */ + SoftwareInstallationPending: "SoftwareInstallationPending", + + /** + * Software installation is in progress. + */ + SoftwareInstallationInProgress: "SoftwareInstallationInProgress", + + /** + * Software installation failed. + */ + SoftwareInstallationFailed: "SoftwareInstallationFailed", + + /** + * Software detection is in progress. + */ + SoftwareDetectionInProgress: "SoftwareDetectionInProgress", + + /** + * Software detection failed. + */ + SoftwareDetectionFailed: "SoftwareDetectionFailed", + + /** + * Registration has not started. + */ + DiscoveryPending: "DiscoveryPending", + + /** + * Registration is in progress. + */ + DiscoveryInProgress: "DiscoveryInProgress", + + /** + * Registration has failed. + */ + DiscoveryFailed: "DiscoveryFailed", + + /** + * Registration is complete. + */ + RegistrationComplete: "RegistrationComplete", + + /** + * ACSS installation cannot proceed. + */ + ACSSInstallationBlocked: "ACSSInstallationBlocked", +} + +/** + * Defines the provisioning states. + */ +union SapVirtualInstanceProvisioningState { + string, + + /** + * ACSS succeeded provisioning state. + */ + Succeeded: "Succeeded", + + /** + * ACSS updating provisioning state. + */ + Updating: "Updating", + + /** + * ACSS Creating provisioning state. + */ + Creating: "Creating", + + /** + * ACSS Failed provisioning state. + */ + Failed: "Failed", + + /** + * ACSS Deleting provisioning state. + */ + Deleting: "Deleting", + + /** + * ACSS Canceled provisioning state. + */ + Canceled: "Canceled", +} + +/** + * Defines the type of Enqueue Replication Server. + */ +union EnqueueReplicationServerType { + string, + + /** + * Enqueue Replication server type 1. + */ + EnqueueReplicator1: "EnqueueReplicator1", + + /** + * Enqueue Replication server type 2. + */ + EnqueueReplicator2: "EnqueueReplicator2", +} + +/** + * Defines the type of central server VM. + */ +union CentralServerVirtualMachineType { + string, + + /** + * Primary central server vm. + */ + Primary: "Primary", + + /** + * Secondary central server vm. + */ + Secondary: "Secondary", + + /** + * Central server vm type unknown. + */ + Unknown: "Unknown", + + /** + * ASCS Central server vm type. + */ + ASCS: "ASCS", + + /** + * ERSInactive Central server vm type. + */ + ERSInactive: "ERSInactive", + + /** + * ERS Central server vm type. + */ + ERS: "ERS", + + /** + * Standby Central server vm type. + */ + Standby: "Standby", +} + +/** + * Defines the type of application server VM. + */ +union ApplicationServerVirtualMachineType { + string, + + /** + * Active Application server vm type. + */ + Active: "Active", + + /** + * Standby Application server vm type. + */ + Standby: "Standby", + + /** + * Unknown Application server vm type. + */ + Unknown: "Unknown", +} + +/** + * The OS Type + */ +union OSType { + string, + + /** + * Linux OS Type. + */ + Linux: "Linux", + + /** + * Windows OS Type. + */ + Windows: "Windows", +} + +/** + * The pattern type to be used for resource naming. + */ +union NamingPatternType { + string, + + /** + * Full resource names that will be created by service. + */ + FullResourceName: "FullResourceName", +} + +/** + * The type of file share config. + */ +union FileShareConfigurationType { + string, + + /** + * Skip creating the file share. + */ + Skip: "Skip", + + /** + * Fileshare will be created and mounted by service. + */ + CreateAndMount: "CreateAndMount", + + /** + * Existing fileshare provided will be mounted by service. + */ + Mount: "Mount", +} + +/** + * The SAP software installation Type. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +union SAPSoftwareInstallationType { + string, + + /** + * SAP Install managed by service. + */ + ServiceInitiated: "ServiceInitiated", + + /** + * SAP Install without OS Config. + */ + SAPInstallWithoutOSConfig: "SAPInstallWithoutOSConfig", + + /** + * External software installation type. + */ + External: "External", +} + +/** + * The SAP Sizing Recommendation request. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPSizingRecommendationRequest { + /** + * The geo-location where the resource is to be created. + */ + appLocation: string; + + /** + * Defines the environment type - Production/Non Production. + */ + environment: SAPEnvironmentType; + + /** + * Defines the SAP Product type. + */ + sapProduct: SAPProductType; + + /** + * The deployment type. Eg: SingleServer/ThreeTier + */ + deploymentType: SAPDeploymentType; + + /** + * The SAP Application Performance Standard measurement. + */ + saps: int64; + + /** + * The database memory configuration. + */ + dbMemory: int64; + + /** + * The database type. + */ + databaseType: SAPDatabaseType; + + /** + * The DB scale method. + */ + dbScaleMethod?: SAPDatabaseScaleMethod; + + /** + * The high availability type. + */ + highAvailabilityType?: SAPHighAvailabilityType; +} + +/** + * The SAP sizing recommendation result. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@discriminator("deploymentType") +model SAPSizingRecommendationResult { + /** + * The deployment type. Eg: SingleServer/ThreeTier + */ + deploymentType: SAPDeploymentType; +} + +/** + * The SAP request to get list of supported SKUs. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPSupportedSkusRequest { + /** + * The geo-location where the resource is to be created. + */ + appLocation: string; + + /** + * Defines the environment type - Production/Non Production. + */ + environment: SAPEnvironmentType; + + /** + * Defines the SAP Product type. + */ + sapProduct: SAPProductType; + + /** + * The deployment type. Eg: SingleServer/ThreeTier + */ + deploymentType: SAPDeploymentType; + + /** + * The database type. Eg: HANA, DB2, etc + */ + databaseType: SAPDatabaseType; + + /** + * The high availability type. + */ + highAvailabilityType?: SAPHighAvailabilityType; +} + +/** + * The list of supported SKUs for different resources which are part of SAP deployment. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPSupportedResourceSkusResult { + /** + * Gets the list of SAP supported SKUs. + */ + @OpenAPI.extension("x-ms-identifiers", []) + supportedSkus?: SAPSupportedSku[]; +} + +/** + * The SAP supported SKU. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPSupportedSku { + /** + * The VM Sku. + */ + vmSku?: string; + + /** + * True if the Sku is certified for App server in the SAP system. + */ + isAppServerCertified?: boolean; + + /** + * True if the Sku is certified for Database server in the SAP system. + */ + isDatabaseCertified?: boolean; +} + +/** + * The SAP request to get list of disk configurations. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPDiskConfigurationsRequest { + /** + * The geo-location where the SAP resources will be created. + */ + appLocation: string; + + /** + * Defines the environment type - Production/Non Production. + */ + environment: SAPEnvironmentType; + + /** + * Defines the SAP Product type. + */ + sapProduct: SAPProductType; + + /** + * The database type. Eg: HANA, DB2, etc + */ + databaseType: SAPDatabaseType; + + /** + * The deployment type. Eg: SingleServer/ThreeTier + */ + deploymentType: SAPDeploymentType; + + /** + * The VM SKU for database instance. + */ + dbVmSku: string; +} + +/** + * The list of disk configuration for vmSku which are part of SAP deployment. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPDiskConfigurationsResult { + /** + * The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup']. + */ + volumeConfigurations?: Record; +} + +/** + * The SAP Disk Configuration contains 'recommended disk' details and list of supported disks detail for a volume type. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPDiskConfiguration { + /** + * The recommended disk details for a given VM Sku. + */ + recommendedConfiguration?: DiskVolumeConfiguration; + + /** + * The list of supported disks for a given VM Sku. + */ + @OpenAPI.extension("x-ms-identifiers", []) + supportedConfigurations?: DiskDetails[]; +} + +/** + * The disk configuration required for the selected volume. + */ +model DiskVolumeConfiguration { + /** + * The total number of disks required for the concerned volume. + */ + count?: int64; + + /** + * The disk size in GB. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "GB represents giga bytes." + sizeGB?: int64; + + /** + * The disk SKU details. + */ + sku?: DiskSku; +} + +/** + * The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS. + */ +model DiskSku { + /** + * Defines the disk sku name. + */ + name?: DiskSkuName; +} + +/** + * The supported disk size details for a disk type. + */ +model DiskDetails { + /** + * The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS. + */ + sku?: DiskSku; + + /** + * The disk size in GB. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "GB represents giga bytes." + sizeGB?: int64; + + /** + * The minimum supported disk count. + */ + minimumSupportedDiskCount?: int64; + + /** + * The maximum supported disk count. + */ + maximumSupportedDiskCount?: int64; + + /** + * The disk Iops. + */ + iopsReadWrite?: int64; + + /** + * The disk provisioned throughput in MBps. + */ + mbpsReadWrite?: int64; + + /** + * The disk tier, e.g. P10, E10. + */ + diskTier?: string; +} + +/** + * The SAP request to get list of availability zones. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPAvailabilityZoneDetailsRequest { + /** + * The geo-location where the SAP resources will be created. + */ + appLocation: string; + + /** + * Defines the SAP Product type. + */ + sapProduct: SAPProductType; + + /** + * The database type. Eg: HANA, DB2, etc + */ + databaseType: SAPDatabaseType; +} + +/** + * The list of supported availability zone pairs which are part of SAP HA deployment. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPAvailabilityZoneDetailsResult { + /** + * Gets the list of availability zone pairs. + */ + @OpenAPI.extension("x-ms-identifiers", []) + availabilityZonePairs?: SAPAvailabilityZonePair[]; +} + +/** + * The SAP Availability Zone Pair. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPAvailabilityZonePair { + /** + * The zone A. + */ + zoneA?: int64; + + /** + * The zone B. + */ + zoneB?: int64; +} + +/** + * Defines the Virtual Instance for SAP solutions resource properties. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPVirtualInstanceProperties { + /** + * Defines the environment type - Production/Non Production. + */ + @visibility("read", "create") + environment: SAPEnvironmentType; + + /** + * Defines the SAP Product type. + */ + @visibility("read", "create") + sapProduct: SAPProductType; + + /** + * Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228 + */ + managedResourcesNetworkAccessType?: ManagedResourcesNetworkAccessType; + + /** + * Defines if the SAP system is being created using Azure Center for SAP solutions (ACSS) or if an existing SAP system is being registered with ACSS + */ + configuration: SAPConfiguration; + + /** + * Managed resource group configuration + */ + managedResourceGroupConfiguration?: ManagedRGConfiguration; + + /** + * Defines the SAP Instance status. + */ + @visibility("read") + status?: SAPVirtualInstanceStatus; + + /** + * Defines the health of SAP Instances. + */ + @visibility("read") + health?: SAPHealthState; + + /** + * Defines the Virtual Instance for SAP state. + */ + @visibility("read") + state?: SAPVirtualInstanceState; + + /** + * Defines the provisioning states. + */ + @visibility("read") + provisioningState?: SapVirtualInstanceProvisioningState; + + /** + * Indicates any errors on the Virtual Instance for SAP solutions resource. + */ + @visibility("read") + errors?: SAPVirtualInstanceError; +} + +/** + * The SAP Configuration. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +@discriminator("configurationType") +model SAPConfiguration { + /** + * The configuration type. Eg: Deployment/Discovery + */ + configurationType: SAPConfigurationType; +} + +/** + * Managed resource group configuration + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "RG represents the resource group." +model ManagedRGConfiguration { + /** + * Managed resource group name + */ + name?: string; +} + +/** + * An error response from the Virtual Instance for SAP Workload service. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPVirtualInstanceError { + /** + * The Virtual Instance for SAP error body. + */ + properties?: ErrorDefinition; +} + +/** + * Error definition. + */ +model ErrorDefinition { + /** + * Service specific error code which serves as the substatus for the HTTP error code. + */ + @visibility("read") + code?: string; + + /** + * Description of the error. + */ + @visibility("read") + message?: string; + + /** + * Internal error details. + */ + @visibility("read") + @OpenAPI.extension("x-ms-identifiers", []) + details?: ErrorDefinition[]; +} + +/** + * Common fields that are returned in the response for all Azure Resource Manager resources + */ +model Resource { + /** + * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + */ + @visibility("read") + id?: string; + + /** + * The name of the resource + */ + @visibility("read") + name?: string; + + /** + * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + */ + @visibility("read") + type?: string; + + /** + * Azure Resource Manager metadata containing createdBy and modifiedBy information. + */ + @visibility("read") + systemData?: SystemData; +} + +/** + * Defines the request body for updating Virtual Instance for SAP. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model UpdateSAPVirtualInstanceRequest { + /** + * Gets or sets the Resource tags. + */ + tags?: Record; + + /** + * Managed service identity (user assigned identities) + */ + identity?: CommonTypes.ManagedServiceIdentity; + + /** + * The update properties. + */ + properties?: UpdateSAPVirtualInstanceProperties; +} + +/** + * Defines the update request body properties for updating Virtual Instance for SAP. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model UpdateSAPVirtualInstanceProperties { + /** + * Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228 + */ + managedResourcesNetworkAccessType?: ManagedResourcesNetworkAccessType; +} + +/** + * Defines the SAP Central Services Instance properties. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPCentralServerProperties { + /** + * The central services instance number. + */ + @visibility("read") + instanceNo?: string; + + /** + * The central services instance subnet. + */ + @visibility("read") + subnet?: string; + + /** + * Defines the SAP message server properties. + */ + messageServerProperties?: MessageServerProperties; + + /** + * Defines the SAP Enqueue Server properties. + */ + enqueueServerProperties?: EnqueueServerProperties; + + /** + * Defines the SAP Gateway Server properties. + */ + gatewayServerProperties?: GatewayServerProperties; + + /** + * Defines the SAP Enqueue Replication Server (ERS) properties. + */ + enqueueReplicationServerProperties?: EnqueueReplicationServerProperties; + + /** + * The central services instance Kernel Version. + */ + @visibility("read") + kernelVersion?: string; + + /** + * The central services instance Kernel Patch level. + */ + @visibility("read") + kernelPatch?: string; + + /** + * The Load Balancer details such as LoadBalancer ID attached to ASCS Virtual Machines + */ + @visibility("read") + loadBalancerDetails?: LoadBalancerDetails; + + /** + * The list of virtual machines corresponding to the Central Services instance. + */ + @visibility("read") + @OpenAPI.extension("x-ms-identifiers", []) + vmDetails?: CentralServerVmDetails[]; + + /** + * Defines the SAP Instance status. + */ + @visibility("read") + status?: SAPVirtualInstanceStatus; + + /** + * Defines the health of SAP Instances. + */ + @visibility("read") + health?: SAPHealthState; + + /** + * Defines the provisioning states. + */ + @visibility("read") + provisioningState?: SapVirtualInstanceProvisioningState; + + /** + * Defines the errors related to SAP Central Services Instance resource. + */ + @visibility("read") + errors?: SAPVirtualInstanceError; +} + +/** + * Defines the SAP message server properties. + */ +model MessageServerProperties { + /** + * message server port. + */ + @visibility("read") + msPort?: int64; + + /** + * message server internal MS port. + */ + @visibility("read") + internalMsPort?: int64; + + /** + * message server HTTP Port. + */ + @visibility("read") + httpPort?: int64; + + /** + * message server HTTPS Port. + */ + @visibility("read") + httpsPort?: int64; + + /** + * message server SAP Hostname. + */ + @visibility("read") + hostname?: string; + + /** + * message server IP Address. + */ + @visibility("read") + ipAddress?: string; + + /** + * Defines the health of SAP Instances. + */ + @visibility("read") + health?: SAPHealthState; +} + +/** + * Defines the SAP Enqueue Server properties. + */ +model EnqueueServerProperties { + /** + * Enqueue Server SAP Hostname. + */ + @visibility("read") + hostname?: string; + + /** + * Enqueue Server SAP IP Address. + */ + @visibility("read") + ipAddress?: string; + + /** + * Enqueue Server Port. + */ + @visibility("read") + port?: int64; + + /** + * Defines the health of SAP Instances. + */ + @visibility("read") + health?: SAPHealthState; +} + +/** + * Defines the SAP Gateway Server properties. + */ +model GatewayServerProperties { + /** + * Gateway Port. + */ + @visibility("read") + port?: int64; + + /** + * Defines the health of SAP Instances. + */ + @visibility("read") + health?: SAPHealthState; +} + +/** + * Defines the SAP Enqueue Replication Server (ERS) properties. + */ +model EnqueueReplicationServerProperties { + /** + * Defines the type of Enqueue Replication Server. + */ + @visibility("read") + ersVersion?: EnqueueReplicationServerType; + + /** + * ERS Instance Number. + */ + @visibility("read") + instanceNo?: string; + + /** + * ERS SAP Hostname. + */ + @visibility("read") + hostname?: string; + + /** + * ERS SAP Kernel Version. + */ + @visibility("read") + kernelVersion?: string; + + /** + * ERS SAP Kernel Patch level. + */ + @visibility("read") + kernelPatch?: string; + + /** + * ERS SAP IP Address. + */ + @visibility("read") + ipAddress?: string; + + /** + * Defines the health of SAP Instances. + */ + @visibility("read") + health?: SAPHealthState; +} + +/** + * The Load Balancer details such as Load Balancer ID. + */ +model LoadBalancerDetails { + /** + * Fully qualified resource ID for the load balancer. + */ + @visibility("read") + id?: string; +} + +/** + * The SAP Central Services Instance VM details. + */ +model CentralServerVmDetails { + /** + * Defines the type of central server VM. + */ + @visibility("read") + type?: CentralServerVirtualMachineType; + + /** + * The virtual machine id. + */ + @visibility("read") + virtualMachineId?: string; + + /** + * Storage details of all the Storage Accounts attached to the ASCS Virtual Machine. For e.g. NFS on AFS Shared Storage. + */ + @visibility("read") + @OpenAPI.extension("x-ms-identifiers", []) + storageDetails?: StorageInformation[]; +} + +/** + * Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage. + */ +model StorageInformation { + /** + * Fully qualified resource ID for the storage account. + */ + @visibility("read") + id?: string; +} + +/** + * Defines the request body for updating SAP Central Instance. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model UpdateSAPCentralInstanceRequest { + /** + * Gets or sets the Resource tags. + */ + tags?: Record; +} + +/** + * Defines the Database properties. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPDatabaseProperties { + /** + * Database subnet. + */ + @visibility("read") + subnet?: string; + + /** + * Database SID name. + */ + @visibility("read") + databaseSid?: string; + + /** + * Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server. + */ + @visibility("read") + databaseType?: string; + + /** + * Database IP Address. + */ + @visibility("read") + ipAddress?: string; + + /** + * The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines + */ + @visibility("read") + loadBalancerDetails?: LoadBalancerDetails; + + /** + * The list of virtual machines corresponding to the Database resource. + */ + @visibility("read") + @OpenAPI.extension("x-ms-identifiers", []) + vmDetails?: DatabaseVmDetails[]; + + /** + * Defines the SAP Instance status. + */ + @visibility("read") + status?: SAPVirtualInstanceStatus; + + /** + * Defines the provisioning states. + */ + @visibility("read") + provisioningState?: SapVirtualInstanceProvisioningState; + + /** + * Defines the errors related to Database resource. + */ + @visibility("read") + errors?: SAPVirtualInstanceError; +} + +/** + * Database VM details. + */ +model DatabaseVmDetails { + /** + * The virtual machine id. + */ + @visibility("read") + virtualMachineId?: string; + + /** + * Defines the SAP Instance status. + */ + @visibility("read") + status?: SAPVirtualInstanceStatus; + + /** + * Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage. + */ + @visibility("read") + @OpenAPI.extension("x-ms-identifiers", []) + storageDetails?: StorageInformation[]; +} + +/** + * Defines the request body for updating SAP Database Instance. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model UpdateSAPDatabaseInstanceRequest { + /** + * Gets or sets the Resource tags. + */ + tags?: Record; +} + +/** + * Defines the SAP Application Server instance properties. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPApplicationServerProperties { + /** + * Application server Instance Number. + */ + @visibility("read") + instanceNo?: string; + + /** + * Application server Subnet. + */ + @visibility("read") + subnet?: string; + + /** + * Application server instance SAP hostname. + */ + @visibility("read") + hostname?: string; + + /** + * Application server instance SAP Kernel Version. + */ + @visibility("read") + kernelVersion?: string; + + /** + * Application server instance SAP Kernel Patch level. + */ + @visibility("read") + kernelPatch?: string; + + /** + * Application server instance SAP IP Address. + */ + @visibility("read") + ipAddress?: string; + + /** + * Application server instance gateway Port. + */ + @visibility("read") + gatewayPort?: int64; + + /** + * Application server instance ICM HTTP Port. + */ + @visibility("read") + icmHttpPort?: int64; + + /** + * Application server instance ICM HTTPS Port. + */ + @visibility("read") + icmHttpsPort?: int64; + + /** + * Application server instance dispatcher status. + */ + @visibility("read") + dispatcherStatus?: string; + + /** + * The Load Balancer details such as LoadBalancer ID attached to Application Server Virtual Machines + */ + @visibility("read") + loadBalancerDetails?: LoadBalancerDetails; + + /** + * The list of virtual machines. + */ + @visibility("read") + @OpenAPI.extension("x-ms-identifiers", []) + vmDetails?: ApplicationServerVmDetails[]; + + /** + * Defines the SAP Instance status. + */ + @visibility("read") + status?: SAPVirtualInstanceStatus; + + /** + * Defines the health of SAP Instances. + */ + @visibility("read") + health?: SAPHealthState; + + /** + * Defines the provisioning states. + */ + @visibility("read") + provisioningState?: SapVirtualInstanceProvisioningState; + + /** + * Defines the Application Instance errors. + */ + @visibility("read") + errors?: SAPVirtualInstanceError; +} + +/** + * The Application Server VM Details. + */ +model ApplicationServerVmDetails { + /** + * Defines the type of application server VM. + */ + @visibility("read") + type?: ApplicationServerVirtualMachineType; + + /** + * The virtual machine id. + */ + @visibility("read") + virtualMachineId?: string; + + /** + * Storage details of all the Storage Accounts attached to the App Virtual Machine. For e.g. NFS on AFS Shared Storage. + */ + @visibility("read") + @OpenAPI.extension("x-ms-identifiers", []) + storageDetails?: StorageInformation[]; +} + +/** + * Defines the request body for updating SAP Application Instance. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model UpdateSAPApplicationInstanceRequest { + /** + * Gets or sets the Resource tags. + */ + tags?: Record; +} + +/** + * Start SAP instance(s) request body. + */ +model StartRequest { + /** + * The boolean value indicates whether to start the virtual machines before starting the SAP instances. + */ + startVm?: boolean = false; +} + +/** + * Stop SAP instance(s) request body. + */ +model StopRequest { + /** + * This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. hard stop. + */ + softStopTimeoutSeconds?: int64 = 0; + + /** + * The boolean value indicates whether to Stop and deallocate the virtual machines along with the SAP instances. + */ + deallocateVm?: boolean = false; +} + +/** + * Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set. + */ +model ImageReference { + /** + * The image publisher. + */ + publisher?: string; + + /** + * Specifies the offer of the platform image or marketplace image used to create the virtual machine. + */ + offer?: string; + + /** + * The image SKU. + */ + sku?: string; + + /** + * Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. + */ + version?: string; + + /** + * Specifies the ARM resource ID of the Azure Compute Gallery image version used for creating ACSS VMs. You will need to provide this input when you choose to deploy virtual machines in ACSS with OS image from the Azure Compute gallery. + */ + id?: Azure.Core.armResourceIdentifier; +} + +/** + * Specifies Windows operating system settings on the virtual machine. + */ +model WindowsConfiguration extends OSConfiguration { + /** + * The OS Type + */ + osType: OSType.Windows; +} + +/** + * Defines the OS configuration. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "OS represents the Operation System." +@discriminator("osType") +model OSConfiguration { + /** + * The OS Type + */ + osType: OSType; +} + +/** + * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. + */ +model SshPublicKey { + /** + * SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). + */ + keyData?: string; +} + +/** + * SSH configuration for Linux based VMs running on Azure + */ +model SshConfiguration { + /** + * The list of SSH public keys used to authenticate with linux based VMs. + */ + @OpenAPI.extension("x-ms-identifiers", []) + publicKeys?: SshPublicKey[]; +} + +/** + * Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). + */ +model LinuxConfiguration extends OSConfiguration { + /** + * Specifies whether password authentication should be disabled. + */ + disablePasswordAuthentication?: boolean; + + /** + * Specifies the ssh key configuration for a Linux OS. (This property is deprecated, please use 'sshKeyPair' instead) + */ + ssh?: SshConfiguration; + + /** + * The SSH Key-pair used to authenticate with the VM's. + */ + sshKeyPair?: SshKeyPair; + + /** + * The OS Type + */ + osType: OSType.Linux; +} + +/** + * The SSH Key-pair used to authenticate with the VM. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). + */ +model SshKeyPair { + /** + * SSH public key + */ + publicKey?: string; + + /** + * SSH private key. + */ + @secret + privateKey?: string; +} + +/** + * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "OS represents the Operation System." +model OSProfile { + /** + * Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. + */ + adminUsername?: string; + + @secret + @doc("Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)") + adminPassword?: string; + + /** + * Specifies Windows operating system settings on the virtual machine. + */ + osConfiguration?: OSConfiguration; +} + +/** + * The recommended configuration for a single server SAP system. + */ +model SingleServerRecommendationResult extends SAPSizingRecommendationResult { + /** + * The recommended VM SKU for single server. + */ + vmSku?: string; + + /** + * The single server SAP deployment type. + */ + deploymentType: SAPDeploymentType.SingleServer; +} + +/** + * The recommended configuration for a three tier SAP system. + */ +model ThreeTierRecommendationResult extends SAPSizingRecommendationResult { + /** + * The database VM SKU. + */ + dbVmSku?: string; + + /** + * The database server instance count. + */ + databaseInstanceCount?: int64; + + /** + * The central server VM SKU. + */ + centralServerVmSku?: string; + + /** + * The central server instance count. + */ + centralServerInstanceCount?: int64; + + /** + * The application server VM SKU. + */ + applicationServerVmSku?: string; + + /** + * The application server instance count. + */ + applicationServerInstanceCount?: int64; + + /** + * The three tier SAP deployment type. + */ + deploymentType: SAPDeploymentType.ThreeTier; +} + +/** + * The Disk Configuration Details. + */ +model DiskConfiguration { + /** + * The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup']. + */ + diskVolumeConfigurations?: Record; +} + +/** + * Defines the virtual machine configuration. + */ +model VirtualMachineConfiguration { + /** + * The virtual machine size. + */ + vmSize: string; + + /** + * The image reference. + */ + imageReference: ImageReference; + + /** + * The OS profile. + */ + osProfile: OSProfile; +} + +/** + * Gets or sets the single server configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409) + */ +model SingleServerConfiguration extends InfrastructureConfiguration { + /** + * Network configuration for the server + */ + networkConfiguration?: NetworkConfiguration; + + /** + * The database type. + */ + databaseType?: SAPDatabaseType; + + /** + * The subnet id. + */ + subnetId: string; + + /** + * Gets or sets the virtual machine configuration. + */ + virtualMachineConfiguration: VirtualMachineConfiguration; + + /** + * Gets or sets the disk configuration. + */ + dbDiskConfiguration?: DiskConfiguration; + + /** + * The set of custom names to be used for underlying azure resources that are part of the SAP system. + */ + customResourceNames?: SingleServerCustomResourceNames; + + /** + * The type of SAP deployment, single server in this case. + */ + deploymentType: SAPDeploymentType.SingleServer; +} + +/** + * Defines the network configuration type for SAP system infrastructure that is being deployed + */ +model NetworkConfiguration { + /** + * Specifies whether a secondary IP address should be added to the network interface on all VMs of the SAP system being deployed + */ + isSecondaryIpEnabled?: boolean = false; +} + +/** + * The resource-names input to specify custom names for underlying azure resources that are part of a single server SAP system. + */ +@discriminator("namingPatternType") +model SingleServerCustomResourceNames { + /** + * The naming pattern type. + */ + namingPatternType: NamingPatternType; +} + +/** + * Deploy SAP Infrastructure Details. + */ +@discriminator("deploymentType") +model InfrastructureConfiguration { + /** + * The application resource group where SAP system resources will be deployed. + */ + appResourceGroup: string; + + /** + * The SAP deployment type. Eg: SingleServer/ThreeTier. + */ + deploymentType: SAPDeploymentType; +} + +/** + * Gets or sets the central server configuration. + */ +model CentralServerConfiguration { + /** + * The subnet id. + */ + subnetId: string; + + /** + * Gets or sets the virtual machine configuration. + */ + virtualMachineConfiguration: VirtualMachineConfiguration; + + /** + * The number of central server VMs. + */ + instanceCount: int64; +} + +/** + * Gets or sets the database configuration. + */ +model DatabaseConfiguration { + /** + * The database type. + */ + databaseType?: SAPDatabaseType; + + /** + * The subnet id. + */ + subnetId: string; + + /** + * Gets or sets the virtual machine configuration. + */ + virtualMachineConfiguration: VirtualMachineConfiguration; + + /** + * The number of database VMs. + */ + instanceCount: int64; + + /** + * Gets or sets the disk configuration. + */ + diskConfiguration?: DiskConfiguration; +} + +/** + * Gets or sets the application server configuration. + */ +model ApplicationServerConfiguration { + /** + * The subnet id. + */ + subnetId: string; + + /** + * Gets or sets the virtual machine configuration. + */ + virtualMachineConfiguration: VirtualMachineConfiguration; + + /** + * The number of app server instances. + */ + instanceCount: int64; +} + +/** + * Gets or sets the high availability configuration. + */ +model HighAvailabilityConfiguration { + /** + * The high availability type. + */ + highAvailabilityType: SAPHighAvailabilityType; +} + +/** + * Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required. + */ +model SkipFileShareConfiguration extends FileShareConfiguration { + /** + * The type of file share config, skip in this case i.e. fileshare is not created or required. + */ + configurationType: FileShareConfigurationType.Skip; +} + +/** + * File Share configuration details, populated with information on storage configuration mounted on the VIS. The createAndMount option is selected in case of missing input. + */ +@discriminator("configurationType") +model FileShareConfiguration { + /** + * The type of file share config, eg: Mount/CreateAndMount/Skip. + */ + configurationType: FileShareConfigurationType; +} + +/** + * Gets or sets the file share configuration where the transport directory fileshare is created and mounted as a part of the create infra flow. Please pre-create the resource group you intend to place the transport directory in. The storage account and fileshare will be auto-created by the ACSS and doesn't need to be pre-created. + */ +model CreateAndMountFileShareConfiguration extends FileShareConfiguration { + /** + * The name of transport file share resource group. This should be pre created by the customer. The app rg is used in case of missing input. + */ + resourceGroup?: string; + + /** + * The name of file share storage account name . A custom name is used in case of missing input. + */ + storageAccountName?: string; + + /** + * The type of file share config. + */ + configurationType: FileShareConfigurationType.CreateAndMount; +} + +/** + * Gets or sets the file share configuration where the transport directory fileshare already exists, and user wishes to mount the fileshare as a part of the create infra flow. + */ +model MountFileShareConfiguration extends FileShareConfiguration { + /** + * The fileshare resource ID + */ + id: string; + + /** + * The private endpoint resource ID + */ + privateEndpointId: string; + + /** + * The type of file share config, mount in this case. + */ + configurationType: FileShareConfigurationType.Mount; +} + +/** + * Gets or sets the storage configuration. + */ +model StorageConfiguration { + /** + * The properties of the transport directory attached to the VIS. The default for transportFileShareConfiguration is the createAndMount flow if storage configuration is missing. + */ + transportFileShareConfiguration?: FileShareConfiguration; +} + +/** + * Gets or sets the three tier SAP configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409) + */ +model ThreeTierConfiguration extends InfrastructureConfiguration { + /** + * Network configuration common to all servers + */ + networkConfiguration?: NetworkConfiguration; + + /** + * The central server configuration. + */ + centralServer: CentralServerConfiguration; + + /** + * The application server configuration. + */ + applicationServer: ApplicationServerConfiguration; + + /** + * The database configuration. + */ + databaseServer: DatabaseConfiguration; + + /** + * The high availability configuration. + */ + highAvailabilityConfig?: HighAvailabilityConfiguration; + + /** + * The storage configuration. + */ + storageConfiguration?: StorageConfiguration; + + /** + * The set of custom names to be used for underlying azure resources that are part of the SAP system. + */ + customResourceNames?: ThreeTierCustomResourceNames; + + /** + * The type of SAP deployment, ThreeTier in this case. + */ + deploymentType: SAPDeploymentType.ThreeTier; +} + +/** + * The resource-names input to specify custom names for underlying azure resources that are part of a three tier SAP system. + */ +@discriminator("namingPatternType") +model ThreeTierCustomResourceNames { + /** + * The pattern type to be used for resource naming. + */ + namingPatternType: NamingPatternType; +} + +/** + * The resource name object where the specified values will be full resource names of the corresponding resources in a single server SAP system. + */ +model SingleServerFullResourceNames extends SingleServerCustomResourceNames { + /** + * The resource names object for virtual machine and related resources. + */ + virtualMachine?: VirtualMachineResourceNames; + + /** + * The pattern type to be used for resource naming. + */ + namingPatternType: NamingPatternType.FullResourceName; +} + +/** + * The resource names object for virtual machine and related resources. + */ +model VirtualMachineResourceNames { + /** + * The full name for virtual machine. The length of this field can be upto 64 characters. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}vm. In case of HA-AvZone systems, default name will be {SID}{app/ascs/db}z{a/b}vm with an incrementor at the end in case of more than 1 vm per layer. For distributed and HA-AvSet systems, default name will be {SID}{app/ascs/db}vm with an incrementor at the end in case of more than 1 vm per layer. + */ + vmName?: string; + + /** + * The full name for virtual-machine's host (computer name). Currently, ACSS only supports host names which are less than or equal to 13 characters long. If this value is not provided, vmName will be used as host name. + */ + hostName?: string; + + /** + * The list of network interface name objects for the selected virtual machine. Currently, only one network interface is supported per virtual machine. + */ + @OpenAPI.extension("x-ms-identifiers", []) + networkInterfaces?: NetworkInterfaceResourceNames[]; + + /** + * The full name for OS disk attached to the VM. If this value is not provided, it will be named by ARM as per its default naming standards (prefixed with vm name). There is only one OS disk attached per Virtual Machine. + */ + osDiskName?: string; + + /** + * The full resource names for virtual machine data disks. This is a dictionary containing list of names of data disks per volume. Currently supported volumes for database layer are ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os', 'backup']. For application and cs layers, only 'default' volume is supported + */ + dataDiskNames?: Record; +} + +/** + * The resource names object for network interface and related resources. + */ +model NetworkInterfaceResourceNames { + /** + * The full name for network interface. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}-Nic. In case of HA-AvZone systems, default name will be {SID}-{App/ASCS/DB}-Zone{A/B}-Nic with an incrementor at the end in case of more than 1 instance per layer. For distributed and HA-AvSet systems, default name will be {SID}-{App/ASCS/DB}-Nic with an incrementor at the end in case of more than 1 instance per layer. + */ + networkInterfaceName?: string; +} + +/** + * The resource name object where the specified values will be full resource names of the corresponding resources in a three tier SAP system. + */ +model ThreeTierFullResourceNames extends ThreeTierCustomResourceNames { + /** + * The full resource names object for central server layer resources. + */ + centralServer?: CentralServerFullResourceNames; + + /** + * The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer. + */ + applicationServer?: ApplicationServerFullResourceNames; + + /** + * The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer. + */ + databaseServer?: DatabaseServerFullResourceNames; + + /** + * The resource names object for shared storage. + */ + sharedStorage?: SharedStorageResourceNames; + + /** + * The pattern type to be used for resource naming, FullResourceName in this case. + */ + namingPatternType: NamingPatternType.FullResourceName; +} + +/** + * The full resource names object for central server layer resources. + */ +model CentralServerFullResourceNames { + /** + * The list of names for all ASCS virtual machines to be deployed. The number of entries in this list should be equal to the number VMs to be created for ASCS layer. At maximum, there can be two virtual machines at this layer: ASCS and ERS. + */ + @OpenAPI.extension("x-ms-identifiers", []) + virtualMachines?: VirtualMachineResourceNames[]; + + /** + * The full name for availability set. In case name is not provided, it will be defaulted to {SID}-ASCS-AvSet. + */ + availabilitySetName?: string; + + /** + * The resource names object for load balancer and related resources. + */ + loadBalancer?: LoadBalancerResourceNames; +} + +/** + * The resource names object for load balancer and related resources. + */ +model LoadBalancerResourceNames { + /** + * The full resource name for load balancer. If this value is not provided, load balancer will be name as {ASCS/DB}-loadBalancer. + */ + loadBalancerName?: string; + + /** + * The list of frontend IP configuration names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer. + */ + frontendIpConfigurationNames?: string[]; + + /** + * The list of backend pool names. Currently, ACSS deploys only one backend pool and hence, size of this list should be 1 + */ + backendPoolNames?: string[]; + + /** + * The list of health probe names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer. + */ + healthProbeNames?: string[]; +} + +/** + * The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer. + */ +model ApplicationServerFullResourceNames { + /** + * The list of virtual machine naming details. + */ + @OpenAPI.extension("x-ms-identifiers", []) + virtualMachines?: VirtualMachineResourceNames[]; + + /** + * The full name for availability set. In case name is not provided, it will be defaulted to {SID}-App-AvSet. + */ + availabilitySetName?: string; +} + +/** + * The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer. + */ +model DatabaseServerFullResourceNames { + /** + * The list of virtual machine naming details. + */ + @OpenAPI.extension("x-ms-identifiers", []) + virtualMachines?: VirtualMachineResourceNames[]; + + /** + * The full name for availability set. In case name is not provided, it will be defaulted to {SID}-DB-AvSet. + */ + availabilitySetName?: string; + + /** + * The resource names object for load balancer and related resources. + */ + loadBalancer?: LoadBalancerResourceNames; +} + +/** + * The resource names object for shared storage. + */ +model SharedStorageResourceNames { + /** + * The full name of the shared storage account. If it is not provided, it will be defaulted to {SID}nfs{guid of 15 chars}. + */ + sharedStorageAccountName?: string; + + /** + * The full name of private end point for the shared storage account. If it is not provided, it will be defaulted to {storageAccountName}_pe + */ + sharedStorageAccountPrivateEndPointName?: string; +} + +/** + * The SAP Software configuration Input. + */ +@discriminator("softwareInstallationType") +model SoftwareConfiguration { + /** + * The SAP software installation type. + */ + softwareInstallationType: SAPSoftwareInstallationType; +} + +/** + * The SAP Software configuration Input when the software is to be installed by service. + */ +model ServiceInitiatedSoftwareConfiguration extends SoftwareConfiguration { + /** + * The URL to the SAP Build of Materials(BOM) file. + */ + bomUrl: string; + + /** + * The software version to install. + */ + softwareVersion: string; + + /** + * The SAP bits storage account id. + */ + sapBitsStorageAccountId: string; + + /** + * The FQDN to set for the SAP system during install. + */ + sapFqdn: string; + + /** + * The SSH private key. + */ + @secret + sshPrivateKey: string; + + /** + * Gets or sets the HA software configuration. + */ + highAvailabilitySoftwareConfiguration?: HighAvailabilitySoftwareConfiguration; + + /** + * The SAP software installation Type, service initiated in this case. + */ + softwareInstallationType: SAPSoftwareInstallationType.ServiceInitiated; +} + +/** + * Gets or sets the HA software configuration. + */ +model HighAvailabilitySoftwareConfiguration { + /** + * The fencing client id. + */ + fencingClientId: string; + + /** + * The fencing client id secret/password. The secret should never expire. This will be used pacemaker to start/stop the cluster VMs. + */ + @secret + fencingClientPassword: string; +} + +/** + * The SAP Software configuration Input when the software is to be installed by service without OS Configurations + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is used for representing the company product." +model SAPInstallWithoutOSConfigSoftwareConfiguration + extends SoftwareConfiguration { + /** + * The URL to the SAP Build of Materials(BOM) file. + */ + bomUrl: string; + + /** + * The SAP bits storage account id. + */ + sapBitsStorageAccountId: string; + + /** + * The software version to install. + */ + softwareVersion: string; + + /** + * Gets or sets the HA software configuration. + */ + highAvailabilitySoftwareConfiguration?: HighAvailabilitySoftwareConfiguration; + + /** + * The SAP software installation Type. + */ + softwareInstallationType: SAPSoftwareInstallationType.SAPInstallWithoutOSConfig; +} + +/** + * The SAP Software configuration Input when the software is installed externally outside the service. + */ +model ExternalInstallationSoftwareConfiguration extends SoftwareConfiguration { + /** + * The resource ID of the virtual machine containing the central server instance. + */ + centralServerVmId?: string; + + /** + * The SAP software installation Type. + */ + softwareInstallationType: SAPSoftwareInstallationType.External; +} + +/** + * Discovery Details. + */ +model DiscoveryConfiguration extends SAPConfiguration { + /** + * The virtual machine ID of the Central Server. + */ + centralServerVmId?: string; + + /** + * The custom storage account name for the storage account created by the service in the managed resource group created as part of VIS deployment.

Refer to the storage account naming rules [here](https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage).

If not provided, the service will create the storage account with a random name. + */ + @maxLength(24) + @minLength(3) + managedRgStorageAccountName?: string; + + /** + * The geo-location where the SAP system exists. + */ + @visibility("read") + appLocation?: string; + + /** + * The configuration Type. + */ + configurationType: SAPConfigurationType.Discovery; +} + +/** + * Deployment Configuration. + */ +model DeploymentConfiguration extends SAPConfiguration { + /** + * The geo-location where the SAP system is to be created. + */ + appLocation?: string; + + /** + * The infrastructure configuration. + */ + infrastructureConfiguration?: InfrastructureConfiguration; + + /** + * The software configuration. + */ + softwareConfiguration?: SoftwareConfiguration; + + /** + * The deployment configuration Type. + */ + configurationType: SAPConfigurationType.Deployment; +} + +/** + * Deployment along with OS Configuration. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "OS represents the Operation System." +model DeploymentWithOSConfiguration extends SAPConfiguration { + /** + * The geo-location where the SAP system is to be created. + */ + appLocation?: string; + + /** + * The infrastructure configuration. + */ + infrastructureConfiguration?: InfrastructureConfiguration; + + /** + * The software configuration. + */ + softwareConfiguration?: SoftwareConfiguration; + + /** + * The OS and SAP configuration. + */ + osSapConfiguration?: OsSapConfiguration; + + /** + * The configuration Type. + */ + configurationType: SAPConfigurationType.DeploymentWithOSConfig; +} + +/** + * Defines the OS and SAP Configurations for Deployment + */ +model OsSapConfiguration { + /** + * The url and storage account ID where deployer VM packages are uploaded + */ + deployerVmPackages?: DeployerVmPackages; + + /** + * The FQDN to set for the SAP system + */ + sapFqdn?: string; +} + +/** + * Defines the url and storage account ID where deployer VM packages are uploaded + */ +model DeployerVmPackages { + /** + * The URL to the deployer VM packages file. + */ + url?: string; + + /** + * The deployer VM packages storage account id + */ + storageAccountId?: string; +} diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml b/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml new file mode 100644 index 000000000000..159a8d7a302c --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml @@ -0,0 +1,16 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + omit-unreachable-types: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + output-file: "{azure-resource-provider-folder}/{service-name}/SAPVirtualInstance/{version-status}/{version}/SAPVirtualInstance.json" + examples-directory: "{project-root}/examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md index df7bae1dd32b..f140347722e9 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md @@ -27,25 +27,35 @@ These are the global settings for the workloads. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2023-10 +tag: package-2024-09 ``` -``` yaml -modelerfour: - flatten-models: false + +### Tag: package-2024-09 + +These settings apply only when `--tag=package-2024-09` is specified on the command line. + +``` yaml $(tag) == 'package-2024-09' +input-file: + - stable/2024-09-01/SAPVirtualInstance.json + - ../common-types/v1/commonTypes.json + - ../operations/stable/2024-09-01/operations.json +suppressions: + - code: BodyTopLevelProperties + from: SAPVirtualInstance.json + reason: This is an incorrect failure due to a bug in the tool ``` ### Tag: package-preview-2023-10 These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-10' +``` yaml $(tag) == 'package-preview-2023-10' input-file: - preview/2023-10-01-preview/SAPVirtualInstance.json - ../common-types/v1/commonTypes.json - ../operations/preview/2023-10-01-preview/operations.json ``` - --- # Code Generation @@ -57,9 +67,10 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-go-track2 - repo: azure-sdk-for-js - repo: azure-sdk-for-net - repo: azure-resource-manager-schemas diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/sdk-suppressions.yaml b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/sdk-suppressions.yaml new file mode 100644 index 000000000000..703f7df29bb1 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/sdk-suppressions.yaml @@ -0,0 +1,59 @@ +suppressions: + azure-sdk-for-go: + - package: 'sdk/resourcemanager/workloadssapvirtualinstance/armworkloadssapvirtualinstance' + breaking-changes: + - Enum `ConfigurationType` has been removed + - Function `*ClientFactory.NewSAPApplicationServerInstancesClient` has been removed + - Function `*ClientFactory.NewSAPCentralInstancesClient` has been removed + - Function `*ClientFactory.NewSAPDatabaseInstancesClient` has been removed + - Function `*ClientFactory.NewSAPVirtualInstancesClient` has been removed + - Function `*ClientFactory.NewWorkloadsClient` has been removed + - Function `*SAPApplicationServerInstancesClient.BeginCreate` has been removed + - Function `*SAPApplicationServerInstancesClient.BeginDelete` has been removed + - Function `*SAPApplicationServerInstancesClient.BeginStartInstance` has been removed + - Function `*SAPApplicationServerInstancesClient.BeginStopInstance` has been removed + - Function `*SAPApplicationServerInstancesClient.Get` has been removed + - Function `*SAPApplicationServerInstancesClient.NewListPager` has been removed + - Function `*SAPApplicationServerInstancesClient.Update` has been removed + - Function `*SAPCentralInstancesClient.BeginCreate` has been removed + - Function `*SAPCentralInstancesClient.BeginDelete` has been removed + - Function `*SAPCentralInstancesClient.BeginStartInstance` has been removed + - Function `*SAPCentralInstancesClient.BeginStopInstance` has been removed + - Function `*SAPCentralInstancesClient.Get` has been removed + - Function `*SAPCentralInstancesClient.NewListPager` has been removed + - Function `*SAPCentralInstancesClient.Update` has been removed + - Function `*SAPDatabaseInstancesClient.BeginCreate` has been removed + - Function `*SAPDatabaseInstancesClient.BeginDelete` has been removed + - Function `*SAPDatabaseInstancesClient.BeginStartInstance` has been removed + - Function `*SAPDatabaseInstancesClient.BeginStopInstance` has been removed + - Function `*SAPDatabaseInstancesClient.Get` has been removed + - Function `*SAPDatabaseInstancesClient.NewListPager` has been removed + - Function `*SAPDatabaseInstancesClient.Update` has been removed + - Function `*SAPVirtualInstancesClient.BeginCreate` has been removed + - Function `*SAPVirtualInstancesClient.BeginDelete` has been removed + - Function `*SAPVirtualInstancesClient.BeginStart` has been removed + - Function `*SAPVirtualInstancesClient.BeginStop` has been removed + - Function `*SAPVirtualInstancesClient.BeginUpdate` has been removed + - Function `*SAPVirtualInstancesClient.Get` has been removed + - Function `*SAPVirtualInstancesClient.NewListByResourceGroupPager` has been removed + - Function `*SAPVirtualInstancesClient.NewListBySubscriptionPager` has been removed + - Function `*WorkloadsClient.SAPAvailabilityZoneDetails` has been removed + - Function `*WorkloadsClient.SAPDiskConfigurations` has been removed + - Function `*WorkloadsClient.SAPSizingRecommendations` has been removed + - Function `*WorkloadsClient.SAPSupportedSKU` has been removed + - Function `NewSAPApplicationServerInstancesClient` has been removed + - Function `NewSAPCentralInstancesClient` has been removed + - Function `NewSAPDatabaseInstancesClient` has been removed + - Function `NewSAPVirtualInstancesClient` has been removed + - Function `NewWorkloadsClient` has been removed + - Struct `SAPApplicationServerInstanceList` has been removed + - Struct `SAPCentralInstanceList` has been removed + - Struct `SAPDatabaseInstanceList` has been removed + - Struct `SAPVirtualInstanceList` has been removed + - Struct `UserAssignedServiceIdentity` has been removed + - Type of `CreateAndMountFileShareConfiguration.ConfigurationType` has been changed from `*ConfigurationType` to `*FileShareConfigurationType` + - Type of `FileShareConfiguration.ConfigurationType` has been changed from `*ConfigurationType` to `*FileShareConfigurationType` + - Type of `MountFileShareConfiguration.ConfigurationType` has been changed from `*ConfigurationType` to `*FileShareConfigurationType` + - Type of `SAPVirtualInstance.Identity` has been changed from `*UserAssignedServiceIdentity` to `*ManagedServiceIdentity` + - Type of `SkipFileShareConfiguration.ConfigurationType` has been changed from `*ConfigurationType` to `*FileShareConfigurationType` + - Type of `UpdateSAPVirtualInstanceRequest.Identity` has been changed from `*UserAssignedServiceIdentity` to `*ManagedServiceIdentity` diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/SAPVirtualInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/SAPVirtualInstance.json new file mode 100644 index 000000000000..8033cf27d1e9 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/SAPVirtualInstance.json @@ -0,0 +1,5163 @@ +{ + "swagger": "2.0", + "info": { + "title": "Workloads Client", + "version": "2024-09-01", + "description": "Workloads client provides access to various workload operations.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SAPVirtualInstances" + }, + { + "name": "SAPCentralServerInstances" + }, + { + "name": "SAPDatabaseInstances" + }, + { + "name": "SAPApplicationServerInstances" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getAvailabilityZoneDetails": { + "post": { + "operationId": "SapVirtualInstances_GetAvailabilityZoneDetails", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Get the recommended SAP Availability Zone Pair Details for your region.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SAPAvailabilityZoneDetailsRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPAvailabilityZoneDetailsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAP Availability zone details in east us": { + "$ref": "./examples/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json" + }, + "SAP Availability zone details in north europe": { + "$ref": "./examples/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getDiskConfigurations": { + "post": { + "operationId": "SapVirtualInstances_GetDiskConfigurations", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Get the SAP Disk Configuration Layout prod/non-prod SAP System.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SAPDiskConfigurationsRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPDiskConfigurationsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAP disk configurations for input environment NonProd.": { + "$ref": "./examples/SapVirtualInstances_GetDiskConfigurations_NonProd.json" + }, + "SAP disk configurations for input environment Prod.": { + "$ref": "./examples/SapVirtualInstances_GetDiskConfigurations_Prod.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getSapSupportedSku": { + "post": { + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Get a list of SAP supported SKUs for ASCS, Application and Database tier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SAPSupportedSkusRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPSupportedResourceSkusResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAP supported SKUs for distributed HA environment with Availability set.": { + "$ref": "./examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json" + }, + "SAP supported SKUs for distributed Non HA environment.": { + "$ref": "./examples/SapVirtualInstances_GetSapSupportedSku_Distributed.json" + }, + "SAP supported SKUs for single server.": { + "$ref": "./examples/SapVirtualInstances_GetSapSupportedSku_SingleServer.json" + }, + "SAP supported Skus for HA with availability zone.": { + "$ref": "./examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getSizingRecommendations": { + "post": { + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Gets the sizing recommendations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SAPSizingRecommendationRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPSizingRecommendationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAP sizing recommendations for HA with availability set.": { + "$ref": "./examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json" + }, + "SAP sizing recommendations for HA with availability zone.": { + "$ref": "./examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json" + }, + "SAP sizing recommendations for non HA distributed system.": { + "$ref": "./examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json" + }, + "SAP sizing recommendations for single server.": { + "$ref": "./examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/sapVirtualInstances": { + "get": { + "operationId": "SapVirtualInstances_ListBySubscription", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Gets all Virtual Instances for SAP solutions resources in a Subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPVirtualInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPVirtualInstances_ListBySubscription": { + "$ref": "./examples/SapVirtualInstances_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances": { + "get": { + "operationId": "SapVirtualInstances_ListByResourceGroup", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Gets all Virtual Instances for SAP solutions resources in a Resource Group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPVirtualInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPVirtualInstances_ListByResourceGroup": { + "$ref": "./examples/SapVirtualInstances_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}": { + "get": { + "operationId": "SapVirtualInstances_Get", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Gets a Virtual Instance for SAP solutions resource", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPVirtualInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPVirtualInstances Get With ACSS Installation Blocked": { + "$ref": "./examples/SapVirtualInstances_GetAcssInstallationBlocked.json" + }, + "SAPVirtualInstances_Get": { + "$ref": "./examples/SapVirtualInstances_Get.json" + } + } + }, + "put": { + "operationId": "SapVirtualInstances_Create", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Creates a Virtual Instance for SAP solutions (VIS) resource", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "resource", + "in": "body", + "description": "Virtual Instance for SAP solutions resource request body.", + "required": true, + "schema": { + "$ref": "#/definitions/SAPVirtualInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SAPVirtualInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/SAPVirtualInstance" + } + }, + "201": { + "description": "Resource 'SAPVirtualInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/SAPVirtualInstance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Infrastructure (with OS configuration) with Azure Compute Gallery Image": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json" + }, + "Create Infrastructure (with OS configuration) with custom resource names for Distributed System": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json" + }, + "Create Infrastructure (with OS configuration) with custom resource names for HA System with Availability Set": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json" + }, + "Create Infrastructure (with OS configuration) with custom resource names for HA system with Availability Zone": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json" + }, + "Create Infrastructure (with OS configuration) with custom resource names for Single Server System": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json" + }, + "Create Infrastructure (with OS configuration) with trusted access enabled": { + "$ref": "./examples/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json" + }, + "Create Infrastructure only for Distributed System": { + "$ref": "./examples/SapVirtualInstances_CreateInfraDS.json" + }, + "Create Infrastructure only for HA System with Availability Set": { + "$ref": "./examples/SapVirtualInstances_CreateInfraHaAvailabilitySet.json" + }, + "Create Infrastructure only for HA System with Availability Zone": { + "$ref": "./examples/SapVirtualInstances_CreateInfraHaAvailabilityZone.json" + }, + "Create Infrastructure only for Single Server System": { + "$ref": "./examples/SapVirtualInstances_CreateInfraSingleServer.json" + }, + "Create Infrastructure with Disk and OS configuration for Distributed System (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json" + }, + "Create Infrastructure with Disk and OS configuration for HA System with Availability Set (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json" + }, + "Create Infrastructure with Disk and OS configuration for HA System with Availability Zone (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json" + }, + "Create Infrastructure with Disk and OS configurations for Single Server System (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json" + }, + "Create Infrastructure with OS configuration for Distributed System (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsDSRecommended.json" + }, + "Create Infrastructure with OS configuration for HA System with Availability Set (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json" + }, + "Create Infrastructure with OS configuration for HA System with Availability Zone (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json" + }, + "Create Infrastructure with OS configuration for Single Server System (Recommended)": { + "$ref": "./examples/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json" + }, + "Create Infrastructure with a new SAP Transport Directory Fileshare": { + "$ref": "./examples/SapVirtualInstances_CreateInfraWithNewFileshare.json" + }, + "Create Infrastructure with an existing SAP Transport Directory Fileshare": { + "$ref": "./examples/SapVirtualInstances_CreateInfraWithExistingFileshare.json" + }, + "Create Infrastructure without a SAP Transport Directory Fileshare": { + "$ref": "./examples/SapVirtualInstances_CreateInfraWithoutFileshare.json" + }, + "Detect SAP Software Installation on a Distributed System": { + "$ref": "./examples/SapVirtualInstances_CreateDetectDS.json" + }, + "Detect SAP Software Installation on a Single Server System": { + "$ref": "./examples/SapVirtualInstances_CreateDetectSingleServer.json" + }, + "Detect SAP Software Installation on an HA System with Availability Set": { + "$ref": "./examples/SapVirtualInstances_CreateDetectHaAvailabilitySet.json" + }, + "Detect SAP Software Installation on an HA System with Availability Zone": { + "$ref": "./examples/SapVirtualInstances_CreateDetectHaAvailabilityZone.json" + }, + "Install SAP Software on Distributed System": { + "$ref": "./examples/SapVirtualInstances_CreateInstallDS.json" + }, + "Install SAP Software on Single Server System": { + "$ref": "./examples/SapVirtualInstances_CreateInstallSingleServer.json" + }, + "Register existing SAP system as Virtual Instance for SAP solutions with optional customizations.": { + "$ref": "./examples/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json" + }, + "Register existing SAP system as Virtual Instance for SAP solutions.": { + "$ref": "./examples/SapVirtualInstances_CreateRegisterSapSolutions.json" + }, + "Register with trusted access enabled": { + "$ref": "./examples/SapVirtualInstances_CreateRegisterWithTrustedAccess.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SapVirtualInstances_Update", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Updates a Virtual Instance for SAP solutions resource", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "properties", + "in": "body", + "description": "Request body to update a Virtual Instance for SAP solutions resource.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSAPVirtualInstanceRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPVirtualInstance" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPVirtualInstances_TrustedAccessEnable_Update": { + "$ref": "./examples/SapVirtualInstances_UpdateTrustedAccess.json" + }, + "SAPVirtualInstances_Update": { + "$ref": "./examples/SapVirtualInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SapVirtualInstances_Delete", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPVirtualInstances_Delete": { + "$ref": "./examples/SapVirtualInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances": { + "get": { + "operationId": "SapApplicationServerInstances_List", + "tags": [ + "SAPApplicationServerInstances" + ], + "description": "Lists the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPApplicationServerInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SapApplicationServerInstances List By SAP Virtual Instance": { + "$ref": "./examples/SapApplicationServerInstances_ListBySapVirtualInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances/{applicationInstanceName}": { + "get": { + "operationId": "SapApplicationServerInstances_Get", + "tags": [ + "SAPApplicationServerInstances" + ], + "description": "Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "applicationInstanceName", + "in": "path", + "description": "The name of SAP Application Server instance resource.", + "required": true, + "type": "string", + "pattern": "^.*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPApplicationServerInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPApplicationServerInstances_Get": { + "$ref": "./examples/SapApplicationServerInstances_Get.json" + } + } + }, + "put": { + "operationId": "SapApplicationServerInstances_Create", + "tags": [ + "SAPApplicationServerInstances" + ], + "description": "Puts the SAP Application Server Instance resource. <br><br>This will be used by service only. PUT by end user will return a Bad Request error.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "applicationInstanceName", + "in": "path", + "description": "The name of SAP Application Server instance resource.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "resource", + "in": "body", + "description": "The SAP Application Server Instance resource request body.", + "required": true, + "schema": { + "$ref": "#/definitions/SAPApplicationServerInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SAPApplicationServerInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/SAPApplicationServerInstance" + } + }, + "201": { + "description": "Resource 'SAPApplicationServerInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/SAPApplicationServerInstance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create SAP Application Server Instances for HA System with Availability Set": { + "$ref": "./examples/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json" + }, + "SAPApplicationServerInstances_Create": { + "$ref": "./examples/SapApplicationServerInstances_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SapApplicationServerInstances_Update", + "tags": [ + "SAPApplicationServerInstances" + ], + "description": "Puts the SAP Application Server Instance resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "applicationInstanceName", + "in": "path", + "description": "The name of SAP Application Server instance resource.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "properties", + "in": "body", + "description": "The SAP Application Server Instance resource request body.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSAPApplicationInstanceRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPApplicationServerInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPApplicationServerInstances_Update": { + "$ref": "./examples/SapApplicationServerInstances_Update.json" + } + } + }, + "delete": { + "operationId": "SapApplicationServerInstances_Delete", + "tags": [ + "SAPApplicationServerInstances" + ], + "description": "Deletes the SAP Application Server Instance resource. <br><br>This operation will be used by service only. Delete by end user will return a Bad Request error.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "applicationInstanceName", + "in": "path", + "description": "The name of SAP Application Server instance resource.", + "required": true, + "type": "string", + "pattern": "^.*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPApplicationServerInstances_Delete": { + "$ref": "./examples/SapApplicationServerInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances/{applicationInstanceName}/start": { + "post": { + "operationId": "SapApplicationServerInstances_Start", + "tags": [ + "SAPApplicationServerInstances" + ], + "description": "Starts the SAP Application Server Instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "applicationInstanceName", + "in": "path", + "description": "The name of SAP Application Server instance resource.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "body", + "in": "body", + "description": "SAP Application server instance start request body.", + "required": true, + "schema": { + "$ref": "#/definitions/StartRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start Virtual Machine and the SAP Application Server Instance on it.": { + "$ref": "./examples/SapApplicationServerInstances_StartInstanceVM.json" + }, + "Start the SAP Application Server Instance.": { + "$ref": "./examples/SapApplicationServerInstances_StartInstance.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances/{applicationInstanceName}/stop": { + "post": { + "operationId": "SapApplicationServerInstances_Stop", + "tags": [ + "SAPApplicationServerInstances" + ], + "description": "Stops the SAP Application Server Instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "applicationInstanceName", + "in": "path", + "description": "The name of SAP Application Server instance resource.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "body", + "in": "body", + "description": "SAP Application server instance stop request body.", + "required": true, + "schema": { + "$ref": "#/definitions/StopRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Soft Stop the SAP Application Server Instance": { + "$ref": "./examples/SapApplicationServerInstances_StopInstanceSoft.json" + }, + "Soft Stop the SAP Application Server Instance and it's infrastructure.": { + "$ref": "./examples/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json" + }, + "Stop the SAP Application Server Instance": { + "$ref": "./examples/SapApplicationServerInstances_StopInstance.json" + }, + "Stop the SAP Application Server Instance and it's infrastructure.": { + "$ref": "./examples/SapApplicationServerInstances_StopInstanceInfrastructure.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances": { + "get": { + "operationId": "SapCentralServerInstances_List", + "tags": [ + "SAPCentralServerInstances" + ], + "description": "Lists the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPCentralServerInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPCentralInstances List by SAP virtual instance": { + "$ref": "./examples/SapCentralServerInstances_ListBySapVirtualInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances/{centralInstanceName}": { + "get": { + "operationId": "SapCentralServerInstances_Get", + "tags": [ + "SAPCentralServerInstances" + ], + "description": "Gets the SAP Central Services Instance resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "centralInstanceName", + "in": "path", + "description": "Central Services Instance resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPCentralServerInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SapCentralServerInstances_Get": { + "$ref": "./examples/SapCentralInstances_Get.json" + } + } + }, + "put": { + "operationId": "SapCentralServerInstances_Create", + "tags": [ + "SAPCentralServerInstances" + ], + "description": "Creates the SAP Central Services Instance resource. <br><br>This will be used by service only. PUT operation on this resource by end user will return a Bad Request error.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "centralInstanceName", + "in": "path", + "description": "Central Services Instance resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "resource", + "in": "body", + "description": "The SAP Central Services Instance request body.", + "required": true, + "schema": { + "$ref": "#/definitions/SAPCentralServerInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SAPCentralServerInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/SAPCentralServerInstance" + } + }, + "201": { + "description": "Resource 'SAPCentralServerInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/SAPCentralServerInstance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create SAP Central Instances for HA System with Availability Set": { + "$ref": "./examples/SapCentralInstances_CreateForHaWithAvailabilitySet.json" + }, + "SapCentralServerInstances_Create": { + "$ref": "./examples/SapCentralInstances_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SapCentralServerInstances_Update", + "tags": [ + "SAPCentralServerInstances" + ], + "description": "Updates the SAP Central Services Instance resource. <br><br>This can be used to update tags on the resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "centralInstanceName", + "in": "path", + "description": "Central Services Instance resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "properties", + "in": "body", + "description": "The SAP Central Services Instance resource request body.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSAPCentralInstanceRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPCentralServerInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SapCentralServerInstances_Update": { + "$ref": "./examples/SapCentralInstances_Update.json" + } + } + }, + "delete": { + "operationId": "SapCentralServerInstances_Delete", + "tags": [ + "SAPCentralServerInstances" + ], + "description": "Deletes the SAP Central Services Instance resource. <br><br>This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the Virtual Instance for SAP solutions resource, using the delete operation on it.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "centralInstanceName", + "in": "path", + "description": "Central Services Instance resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SapCentralServerInstances_Delete": { + "$ref": "./examples/SapCentralInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances/{centralInstanceName}/start": { + "post": { + "operationId": "SapCentralServerInstances_Start", + "tags": [ + "SAPCentralServerInstances" + ], + "description": "Starts the SAP Central Services Instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "centralInstanceName", + "in": "path", + "description": "Central Services Instance resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "body", + "in": "body", + "description": "SAP Central Services instance start request body.", + "required": true, + "schema": { + "$ref": "#/definitions/StartRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start the SAP Central Services Instance": { + "$ref": "./examples/SapCentralInstances_StartInstance.json" + }, + "Start the virtual machine(s) and the SAP central services instance on it.": { + "$ref": "./examples/SapCentralInstances_StartInstanceVM.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances/{centralInstanceName}/stop": { + "post": { + "operationId": "SapCentralServerInstances_Stop", + "tags": [ + "SAPCentralServerInstances" + ], + "description": "Stops the SAP Central Services Instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "centralInstanceName", + "in": "path", + "description": "Central Services Instance resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "body", + "in": "body", + "description": "SAP Central Services instance stop request body.", + "required": true, + "schema": { + "$ref": "#/definitions/StopRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop the SAP Central Services Instance and its underlying Virtual Machine(s)": { + "$ref": "./examples/SapCentralInstances_StopInstanceVM.json" + }, + "Stop the SAP Central Services Instance.": { + "$ref": "./examples/SapCentralInstances_StopInstance.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances": { + "get": { + "operationId": "SapDatabaseInstances_List", + "tags": [ + "SAPDatabaseInstances" + ], + "description": "Lists the Database resources associated with a Virtual Instance for SAP solutions resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPDatabaseInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPDatabaseInstances list by SAP virtual instance": { + "$ref": "./examples/SapDatabaseInstances_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances/{databaseInstanceName}": { + "get": { + "operationId": "SapDatabaseInstances_Get", + "tags": [ + "SAPDatabaseInstances" + ], + "description": "Gets the SAP Database Instance resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "databaseInstanceName", + "in": "path", + "description": "Database resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPDatabaseInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPDatabaseInstances_Get": { + "$ref": "./examples/SapDatabaseInstances_Get.json" + } + } + }, + "put": { + "operationId": "SapDatabaseInstances_Create", + "tags": [ + "SAPDatabaseInstances" + ], + "description": "Creates the Database resource corresponding to the Virtual Instance for SAP solutions resource. <br><br>This will be used by service only. PUT by end user will return a Bad Request error.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "databaseInstanceName", + "in": "path", + "description": "Database resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "resource", + "in": "body", + "description": "Request body of Database resource of a SAP system.", + "required": true, + "schema": { + "$ref": "#/definitions/SAPDatabaseInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SAPDatabaseInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/SAPDatabaseInstance" + } + }, + "201": { + "description": "Resource 'SAPDatabaseInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/SAPDatabaseInstance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create SAP Database Instances for HA System with Availability Set": { + "$ref": "./examples/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json" + }, + "SAPDatabaseInstances_Create": { + "$ref": "./examples/SapDatabaseInstances_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SapDatabaseInstances_Update", + "tags": [ + "SAPDatabaseInstances" + ], + "description": "Updates the Database resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "databaseInstanceName", + "in": "path", + "description": "Database resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "properties", + "in": "body", + "description": "Database resource update request body.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSAPDatabaseInstanceRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SAPDatabaseInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPDatabaseInstances_Update": { + "$ref": "./examples/SapDatabaseInstances_Update.json" + } + } + }, + "delete": { + "operationId": "SapDatabaseInstances_Delete", + "tags": [ + "SAPDatabaseInstances" + ], + "description": "Deletes the Database resource corresponding to a Virtual Instance for SAP solutions resource. <br><br>This will be used by service only. Delete by end user will return a Bad Request error.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "databaseInstanceName", + "in": "path", + "description": "Database resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPDatabaseInstances_Delete": { + "$ref": "./examples/SapDatabaseInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances/{databaseInstanceName}/start": { + "post": { + "operationId": "SapDatabaseInstances_Start", + "tags": [ + "SAPDatabaseInstances" + ], + "description": "Starts the database instance of the SAP system.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "databaseInstanceName", + "in": "path", + "description": "Database resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "body", + "in": "body", + "description": "SAP Database server instance start request body.", + "required": true, + "schema": { + "$ref": "#/definitions/StartRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start Virtual Machine and the database instance of the SAP system on it.": { + "$ref": "./examples/SapDatabaseInstances_StartInstanceVM.json" + }, + "Start the database instance of the SAP system.": { + "$ref": "./examples/SapDatabaseInstances_StartInstance.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances/{databaseInstanceName}/stop": { + "post": { + "operationId": "SapDatabaseInstances_Stop", + "tags": [ + "SAPDatabaseInstances" + ], + "description": "Stops the database instance of the SAP system.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "databaseInstanceName", + "in": "path", + "description": "Database resource name string modeled as parameter for auto generation to work correctly.", + "required": true, + "type": "string", + "pattern": "^.*" + }, + { + "name": "body", + "in": "body", + "description": "Stop request for the database instance of the SAP system.", + "required": true, + "schema": { + "$ref": "#/definitions/StopRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Soft Stop the database instance of the SAP system and the underlying Virtual Machine(s).": { + "$ref": "./examples/SapDatabaseInstances_StopInstanceSoftVM.json" + }, + "Soft Stop the database instance of the SAP system.": { + "$ref": "./examples/SapDatabaseInstances_StopInstanceSoft.json" + }, + "Stop the database instance of the SAP system and the underlying Virtual Machine(s).": { + "$ref": "./examples/SapDatabaseInstances_StopInstanceVM.json" + }, + "Stop the database instance of the SAP system.": { + "$ref": "./examples/SapDatabaseInstances_StopInstance.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/start": { + "post": { + "operationId": "SapVirtualInstances_Start", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Starts the SAP application, that is the Central Services instance and Application server instances.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "body", + "in": "body", + "description": "The Virtual Instance for SAP solutions resource start request body.", + "required": true, + "schema": { + "$ref": "#/definitions/StartRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPVirtualInstances_Start": { + "$ref": "./examples/SapVirtualInstances_Start.json" + }, + "SAPVirtualInstances_Start_WithInfraOperations": { + "$ref": "./examples/SapVirtualInstances_StartWithInfraOperations.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/stop": { + "post": { + "operationId": "SapVirtualInstances_Stop", + "tags": [ + "SAPVirtualInstances" + ], + "description": "Stops the SAP Application, that is the Application server instances and Central Services instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "sapVirtualInstanceName", + "in": "path", + "description": "The name of the Virtual Instances for SAP solutions resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$" + }, + { + "name": "body", + "in": "body", + "description": "The Virtual Instance for SAP solutions resource stop request body.", + "required": true, + "schema": { + "$ref": "#/definitions/StopRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SAPVirtualInstances_Stop": { + "$ref": "./examples/SapVirtualInstances_Stop.json" + }, + "Soft Stop of SapVirtualInstances_Stop": { + "$ref": "./examples/SapVirtualInstances_SoftStop.json" + }, + "Soft Stop the virtual machine(s) and the SAP system on it.": { + "$ref": "./examples/SapVirtualInstances_SoftStopVMAndSystem.json" + }, + "Stop the virtual machine(s) and the SAP system on it.": { + "$ref": "./examples/SapVirtualInstances_StopVMAndSystem.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApplicationServerConfiguration": { + "type": "object", + "description": "Gets or sets the application server configuration.", + "properties": { + "subnetId": { + "type": "string", + "description": "The subnet id." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "description": "Gets or sets the virtual machine configuration." + }, + "instanceCount": { + "type": "integer", + "format": "int64", + "description": "The number of app server instances." + } + }, + "required": [ + "subnetId", + "virtualMachineConfiguration", + "instanceCount" + ] + }, + "ApplicationServerFullResourceNames": { + "type": "object", + "description": "The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer.", + "properties": { + "virtualMachines": { + "type": "array", + "description": "The list of virtual machine naming details.", + "items": { + "$ref": "#/definitions/VirtualMachineResourceNames" + }, + "x-ms-identifiers": [] + }, + "availabilitySetName": { + "type": "string", + "description": "The full name for availability set. In case name is not provided, it will be defaulted to {SID}-App-AvSet." + } + } + }, + "ApplicationServerVirtualMachineType": { + "type": "string", + "description": "Defines the type of application server VM.", + "enum": [ + "Active", + "Standby", + "Unknown" + ], + "x-ms-enum": { + "name": "ApplicationServerVirtualMachineType", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Active Application server vm type." + }, + { + "name": "Standby", + "value": "Standby", + "description": "Standby Application server vm type." + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Application server vm type." + } + ] + } + }, + "ApplicationServerVmDetails": { + "type": "object", + "description": "The Application Server VM Details.", + "properties": { + "type": { + "$ref": "#/definitions/ApplicationServerVirtualMachineType", + "description": "Defines the type of application server VM.", + "readOnly": true + }, + "virtualMachineId": { + "type": "string", + "description": "The virtual machine id.", + "readOnly": true + }, + "storageDetails": { + "type": "array", + "description": "Storage details of all the Storage Accounts attached to the App Virtual Machine. For e.g. NFS on AFS Shared Storage.", + "items": { + "$ref": "#/definitions/StorageInformation" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "CentralServerConfiguration": { + "type": "object", + "description": "Gets or sets the central server configuration.", + "properties": { + "subnetId": { + "type": "string", + "description": "The subnet id." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "description": "Gets or sets the virtual machine configuration." + }, + "instanceCount": { + "type": "integer", + "format": "int64", + "description": "The number of central server VMs." + } + }, + "required": [ + "subnetId", + "virtualMachineConfiguration", + "instanceCount" + ] + }, + "CentralServerFullResourceNames": { + "type": "object", + "description": "The full resource names object for central server layer resources.", + "properties": { + "virtualMachines": { + "type": "array", + "description": "The list of names for all ASCS virtual machines to be deployed. The number of entries in this list should be equal to the number VMs to be created for ASCS layer. At maximum, there can be two virtual machines at this layer: ASCS and ERS.", + "items": { + "$ref": "#/definitions/VirtualMachineResourceNames" + }, + "x-ms-identifiers": [] + }, + "availabilitySetName": { + "type": "string", + "description": "The full name for availability set. In case name is not provided, it will be defaulted to {SID}-ASCS-AvSet." + }, + "loadBalancer": { + "$ref": "#/definitions/LoadBalancerResourceNames", + "description": "The resource names object for load balancer and related resources." + } + } + }, + "CentralServerVirtualMachineType": { + "type": "string", + "description": "Defines the type of central server VM.", + "enum": [ + "Primary", + "Secondary", + "Unknown", + "ASCS", + "ERSInactive", + "ERS", + "Standby" + ], + "x-ms-enum": { + "name": "CentralServerVirtualMachineType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary central server vm." + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary central server vm." + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Central server vm type unknown." + }, + { + "name": "ASCS", + "value": "ASCS", + "description": "ASCS Central server vm type." + }, + { + "name": "ERSInactive", + "value": "ERSInactive", + "description": "ERSInactive Central server vm type." + }, + { + "name": "ERS", + "value": "ERS", + "description": "ERS Central server vm type." + }, + { + "name": "Standby", + "value": "Standby", + "description": "Standby Central server vm type." + } + ] + } + }, + "CentralServerVmDetails": { + "type": "object", + "description": "The SAP Central Services Instance VM details.", + "properties": { + "type": { + "$ref": "#/definitions/CentralServerVirtualMachineType", + "description": "Defines the type of central server VM.", + "readOnly": true + }, + "virtualMachineId": { + "type": "string", + "description": "The virtual machine id.", + "readOnly": true + }, + "storageDetails": { + "type": "array", + "description": "Storage details of all the Storage Accounts attached to the ASCS Virtual Machine. For e.g. NFS on AFS Shared Storage.", + "items": { + "$ref": "#/definitions/StorageInformation" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "CreateAndMountFileShareConfiguration": { + "type": "object", + "description": "Gets or sets the file share configuration where the transport directory fileshare is created and mounted as a part of the create infra flow. Please pre-create the resource group you intend to place the transport directory in. The storage account and fileshare will be auto-created by the ACSS and doesn't need to be pre-created.", + "properties": { + "resourceGroup": { + "type": "string", + "description": "The name of transport file share resource group. This should be pre created by the customer. The app rg is used in case of missing input." + }, + "storageAccountName": { + "type": "string", + "description": "The name of file share storage account name . A custom name is used in case of missing input." + } + }, + "allOf": [ + { + "$ref": "#/definitions/FileShareConfiguration" + } + ], + "x-ms-discriminator-value": "CreateAndMount" + }, + "DatabaseConfiguration": { + "type": "object", + "description": "Gets or sets the database configuration.", + "properties": { + "databaseType": { + "$ref": "#/definitions/SAPDatabaseType", + "description": "The database type." + }, + "subnetId": { + "type": "string", + "description": "The subnet id." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "description": "Gets or sets the virtual machine configuration." + }, + "instanceCount": { + "type": "integer", + "format": "int64", + "description": "The number of database VMs." + }, + "diskConfiguration": { + "$ref": "#/definitions/DiskConfiguration", + "description": "Gets or sets the disk configuration." + } + }, + "required": [ + "subnetId", + "virtualMachineConfiguration", + "instanceCount" + ] + }, + "DatabaseServerFullResourceNames": { + "type": "object", + "description": "The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer.", + "properties": { + "virtualMachines": { + "type": "array", + "description": "The list of virtual machine naming details.", + "items": { + "$ref": "#/definitions/VirtualMachineResourceNames" + }, + "x-ms-identifiers": [] + }, + "availabilitySetName": { + "type": "string", + "description": "The full name for availability set. In case name is not provided, it will be defaulted to {SID}-DB-AvSet." + }, + "loadBalancer": { + "$ref": "#/definitions/LoadBalancerResourceNames", + "description": "The resource names object for load balancer and related resources." + } + } + }, + "DatabaseVmDetails": { + "type": "object", + "description": "Database VM details.", + "properties": { + "virtualMachineId": { + "type": "string", + "description": "The virtual machine id.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/SAPVirtualInstanceStatus", + "description": "Defines the SAP Instance status.", + "readOnly": true + }, + "storageDetails": { + "type": "array", + "description": "Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.", + "items": { + "$ref": "#/definitions/StorageInformation" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "DeployerVmPackages": { + "type": "object", + "description": "Defines the url and storage account ID where deployer VM packages are uploaded", + "properties": { + "url": { + "type": "string", + "description": "The URL to the deployer VM packages file." + }, + "storageAccountId": { + "type": "string", + "description": "The deployer VM packages storage account id" + } + } + }, + "DeploymentConfiguration": { + "type": "object", + "description": "Deployment Configuration.", + "properties": { + "appLocation": { + "type": "string", + "description": "The geo-location where the SAP system is to be created." + }, + "infrastructureConfiguration": { + "$ref": "#/definitions/InfrastructureConfiguration", + "description": "The infrastructure configuration." + }, + "softwareConfiguration": { + "$ref": "#/definitions/SoftwareConfiguration", + "description": "The software configuration." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SAPConfiguration" + } + ], + "x-ms-discriminator-value": "Deployment" + }, + "DeploymentWithOSConfiguration": { + "type": "object", + "description": "Deployment along with OS Configuration.", + "properties": { + "appLocation": { + "type": "string", + "description": "The geo-location where the SAP system is to be created." + }, + "infrastructureConfiguration": { + "$ref": "#/definitions/InfrastructureConfiguration", + "description": "The infrastructure configuration." + }, + "softwareConfiguration": { + "$ref": "#/definitions/SoftwareConfiguration", + "description": "The software configuration." + }, + "osSapConfiguration": { + "$ref": "#/definitions/OsSapConfiguration", + "description": "The OS and SAP configuration." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SAPConfiguration" + } + ], + "x-ms-discriminator-value": "DeploymentWithOSConfig" + }, + "DiscoveryConfiguration": { + "type": "object", + "description": "Discovery Details.", + "properties": { + "centralServerVmId": { + "type": "string", + "description": "The virtual machine ID of the Central Server." + }, + "managedRgStorageAccountName": { + "type": "string", + "description": "The custom storage account name for the storage account created by the service in the managed resource group created as part of VIS deployment.

Refer to the storage account naming rules [here](https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage).

If not provided, the service will create the storage account with a random name.", + "minLength": 3, + "maxLength": 24 + }, + "appLocation": { + "type": "string", + "description": "The geo-location where the SAP system exists.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/SAPConfiguration" + } + ], + "x-ms-discriminator-value": "Discovery" + }, + "DiskConfiguration": { + "type": "object", + "description": "The Disk Configuration Details.", + "properties": { + "diskVolumeConfigurations": { + "type": "object", + "description": "The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup'].", + "additionalProperties": { + "$ref": "#/definitions/DiskVolumeConfiguration" + } + } + } + }, + "DiskDetails": { + "type": "object", + "description": "The supported disk size details for a disk type.", + "properties": { + "sku": { + "$ref": "#/definitions/DiskSku", + "description": "The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS." + }, + "sizeGB": { + "type": "integer", + "format": "int64", + "description": "The disk size in GB." + }, + "minimumSupportedDiskCount": { + "type": "integer", + "format": "int64", + "description": "The minimum supported disk count." + }, + "maximumSupportedDiskCount": { + "type": "integer", + "format": "int64", + "description": "The maximum supported disk count." + }, + "iopsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The disk Iops." + }, + "mbpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The disk provisioned throughput in MBps." + }, + "diskTier": { + "type": "string", + "description": "The disk tier, e.g. P10, E10." + } + } + }, + "DiskSku": { + "type": "object", + "description": "The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS.", + "properties": { + "name": { + "$ref": "#/definitions/DiskSkuName", + "description": "Defines the disk sku name." + } + } + }, + "DiskSkuName": { + "type": "string", + "description": "Defines the disk sku name.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "DiskSkuName", + "modelAsString": true, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "Standard LRS Disk SKU." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "Premium_LRS Disk SKU." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "StandardSSD_LRS Disk SKU." + }, + { + "name": "UltraSSD_LRS", + "value": "UltraSSD_LRS", + "description": "UltraSSD_LRS Disk SKU." + }, + { + "name": "Premium_ZRS", + "value": "Premium_ZRS", + "description": "Premium_ZRS Disk SKU." + }, + { + "name": "StandardSSD_ZRS", + "value": "StandardSSD_ZRS", + "description": "StandardSSD_ZRS Disk SKU." + }, + { + "name": "PremiumV2_LRS", + "value": "PremiumV2_LRS", + "description": "PremiumV2_LRS Disk SKU." + } + ] + } + }, + "DiskVolumeConfiguration": { + "type": "object", + "description": "The disk configuration required for the selected volume.", + "properties": { + "count": { + "type": "integer", + "format": "int64", + "description": "The total number of disks required for the concerned volume." + }, + "sizeGB": { + "type": "integer", + "format": "int64", + "description": "The disk size in GB." + }, + "sku": { + "$ref": "#/definitions/DiskSku", + "description": "The disk SKU details." + } + } + }, + "EnqueueReplicationServerProperties": { + "type": "object", + "description": "Defines the SAP Enqueue Replication Server (ERS) properties.", + "properties": { + "ersVersion": { + "$ref": "#/definitions/EnqueueReplicationServerType", + "description": "Defines the type of Enqueue Replication Server.", + "readOnly": true + }, + "instanceNo": { + "type": "string", + "description": "ERS Instance Number.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "ERS SAP Hostname.", + "readOnly": true + }, + "kernelVersion": { + "type": "string", + "description": "ERS SAP Kernel Version.", + "readOnly": true + }, + "kernelPatch": { + "type": "string", + "description": "ERS SAP Kernel Patch level.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "ERS SAP IP Address.", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/SAPHealthState", + "description": "Defines the health of SAP Instances.", + "readOnly": true + } + } + }, + "EnqueueReplicationServerType": { + "type": "string", + "description": "Defines the type of Enqueue Replication Server.", + "enum": [ + "EnqueueReplicator1", + "EnqueueReplicator2" + ], + "x-ms-enum": { + "name": "EnqueueReplicationServerType", + "modelAsString": true, + "values": [ + { + "name": "EnqueueReplicator1", + "value": "EnqueueReplicator1", + "description": "Enqueue Replication server type 1." + }, + { + "name": "EnqueueReplicator2", + "value": "EnqueueReplicator2", + "description": "Enqueue Replication server type 2." + } + ] + } + }, + "EnqueueServerProperties": { + "type": "object", + "description": "Defines the SAP Enqueue Server properties.", + "properties": { + "hostname": { + "type": "string", + "description": "Enqueue Server SAP Hostname.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "Enqueue Server SAP IP Address.", + "readOnly": true + }, + "port": { + "type": "integer", + "format": "int64", + "description": "Enqueue Server Port.", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/SAPHealthState", + "description": "Defines the health of SAP Instances.", + "readOnly": true + } + } + }, + "ErrorDefinition": { + "type": "object", + "description": "Error definition.", + "properties": { + "code": { + "type": "string", + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Description of the error.", + "readOnly": true + }, + "details": { + "type": "array", + "description": "Internal error details.", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ExternalInstallationSoftwareConfiguration": { + "type": "object", + "description": "The SAP Software configuration Input when the software is installed externally outside the service.", + "properties": { + "centralServerVmId": { + "type": "string", + "description": "The resource ID of the virtual machine containing the central server instance." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SoftwareConfiguration" + } + ], + "x-ms-discriminator-value": "External" + }, + "FileShareConfiguration": { + "type": "object", + "description": "File Share configuration details, populated with information on storage configuration mounted on the VIS. The createAndMount option is selected in case of missing input.", + "properties": { + "configurationType": { + "$ref": "#/definitions/FileShareConfigurationType", + "description": "The type of file share config, eg: Mount/CreateAndMount/Skip." + } + }, + "discriminator": "configurationType", + "required": [ + "configurationType" + ] + }, + "FileShareConfigurationType": { + "type": "string", + "description": "The type of file share config.", + "enum": [ + "Skip", + "CreateAndMount", + "Mount" + ], + "x-ms-enum": { + "name": "FileShareConfigurationType", + "modelAsString": true, + "values": [ + { + "name": "Skip", + "value": "Skip", + "description": "Skip creating the file share." + }, + { + "name": "CreateAndMount", + "value": "CreateAndMount", + "description": "Fileshare will be created and mounted by service." + }, + { + "name": "Mount", + "value": "Mount", + "description": "Existing fileshare provided will be mounted by service." + } + ] + } + }, + "GatewayServerProperties": { + "type": "object", + "description": "Defines the SAP Gateway Server properties.", + "properties": { + "port": { + "type": "integer", + "format": "int64", + "description": "Gateway Port.", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/SAPHealthState", + "description": "Defines the health of SAP Instances.", + "readOnly": true + } + } + }, + "HighAvailabilityConfiguration": { + "type": "object", + "description": "Gets or sets the high availability configuration.", + "properties": { + "highAvailabilityType": { + "$ref": "#/definitions/SAPHighAvailabilityType", + "description": "The high availability type." + } + }, + "required": [ + "highAvailabilityType" + ] + }, + "HighAvailabilitySoftwareConfiguration": { + "type": "object", + "description": "Gets or sets the HA software configuration.", + "properties": { + "fencingClientId": { + "type": "string", + "description": "The fencing client id." + }, + "fencingClientPassword": { + "type": "string", + "format": "password", + "description": "The fencing client id secret/password. The secret should never expire. This will be used pacemaker to start/stop the cluster VMs.", + "x-ms-secret": true + } + }, + "required": [ + "fencingClientId", + "fencingClientPassword" + ] + }, + "ImageReference": { + "type": "object", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.", + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." + }, + "id": { + "type": "string", + "format": "arm-id", + "description": "Specifies the ARM resource ID of the Azure Compute Gallery image version used for creating ACSS VMs. You will need to provide this input when you choose to deploy virtual machines in ACSS with OS image from the Azure Compute gallery." + } + } + }, + "InfrastructureConfiguration": { + "type": "object", + "description": "Deploy SAP Infrastructure Details.", + "properties": { + "appResourceGroup": { + "type": "string", + "description": "The application resource group where SAP system resources will be deployed." + }, + "deploymentType": { + "$ref": "#/definitions/SAPDeploymentType", + "description": "The SAP deployment type. Eg: SingleServer/ThreeTier." + } + }, + "discriminator": "deploymentType", + "required": [ + "appResourceGroup", + "deploymentType" + ] + }, + "LinuxConfiguration": { + "type": "object", + "description": "Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS. (This property is deprecated, please use 'sshKeyPair' instead)" + }, + "sshKeyPair": { + "$ref": "#/definitions/SshKeyPair", + "description": "The SSH Key-pair used to authenticate with the VM's." + } + }, + "allOf": [ + { + "$ref": "#/definitions/OSConfiguration" + } + ], + "x-ms-discriminator-value": "Linux" + }, + "LoadBalancerDetails": { + "type": "object", + "description": "The Load Balancer details such as Load Balancer ID.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified resource ID for the load balancer.", + "readOnly": true + } + } + }, + "LoadBalancerResourceNames": { + "type": "object", + "description": "The resource names object for load balancer and related resources.", + "properties": { + "loadBalancerName": { + "type": "string", + "description": "The full resource name for load balancer. If this value is not provided, load balancer will be name as {ASCS/DB}-loadBalancer." + }, + "frontendIpConfigurationNames": { + "type": "array", + "description": "The list of frontend IP configuration names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer.", + "items": { + "type": "string" + } + }, + "backendPoolNames": { + "type": "array", + "description": "The list of backend pool names. Currently, ACSS deploys only one backend pool and hence, size of this list should be 1", + "items": { + "type": "string" + } + }, + "healthProbeNames": { + "type": "array", + "description": "The list of health probe names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer.", + "items": { + "type": "string" + } + } + } + }, + "ManagedRGConfiguration": { + "type": "object", + "description": "Managed resource group configuration", + "properties": { + "name": { + "type": "string", + "description": "Managed resource group name" + } + } + }, + "ManagedResourcesNetworkAccessType": { + "type": "string", + "description": "Defines the network access type for managed resources.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ManagedResourcesNetworkAccessType", + "modelAsString": true, + "values": [ + { + "name": "Public", + "value": "Public", + "description": "Managed resources will be deployed with public network access enabled." + }, + { + "name": "Private", + "value": "Private", + "description": "Managed resources will be deployed with public network access disabled." + } + ] + } + }, + "MessageServerProperties": { + "type": "object", + "description": "Defines the SAP message server properties.", + "properties": { + "msPort": { + "type": "integer", + "format": "int64", + "description": "message server port.", + "readOnly": true + }, + "internalMsPort": { + "type": "integer", + "format": "int64", + "description": "message server internal MS port.", + "readOnly": true + }, + "httpPort": { + "type": "integer", + "format": "int64", + "description": "message server HTTP Port.", + "readOnly": true + }, + "httpsPort": { + "type": "integer", + "format": "int64", + "description": "message server HTTPS Port.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "message server SAP Hostname.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "message server IP Address.", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/SAPHealthState", + "description": "Defines the health of SAP Instances.", + "readOnly": true + } + } + }, + "MountFileShareConfiguration": { + "type": "object", + "description": "Gets or sets the file share configuration where the transport directory fileshare already exists, and user wishes to mount the fileshare as a part of the create infra flow.", + "properties": { + "id": { + "type": "string", + "description": "The fileshare resource ID" + }, + "privateEndpointId": { + "type": "string", + "description": "The private endpoint resource ID" + } + }, + "required": [ + "id", + "privateEndpointId" + ], + "allOf": [ + { + "$ref": "#/definitions/FileShareConfiguration" + } + ], + "x-ms-discriminator-value": "Mount" + }, + "NamingPatternType": { + "type": "string", + "description": "The pattern type to be used for resource naming.", + "enum": [ + "FullResourceName" + ], + "x-ms-enum": { + "name": "NamingPatternType", + "modelAsString": true, + "values": [ + { + "name": "FullResourceName", + "value": "FullResourceName", + "description": "Full resource names that will be created by service." + } + ] + } + }, + "NetworkConfiguration": { + "type": "object", + "description": "Defines the network configuration type for SAP system infrastructure that is being deployed", + "properties": { + "isSecondaryIpEnabled": { + "type": "boolean", + "description": "Specifies whether a secondary IP address should be added to the network interface on all VMs of the SAP system being deployed", + "default": false + } + } + }, + "NetworkInterfaceResourceNames": { + "type": "object", + "description": "The resource names object for network interface and related resources.", + "properties": { + "networkInterfaceName": { + "type": "string", + "description": "The full name for network interface. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}-Nic. In case of HA-AvZone systems, default name will be {SID}-{App/ASCS/DB}-Zone{A/B}-Nic with an incrementor at the end in case of more than 1 instance per layer. For distributed and HA-AvSet systems, default name will be {SID}-{App/ASCS/DB}-Nic with an incrementor at the end in case of more than 1 instance per layer." + } + } + }, + "OSConfiguration": { + "type": "object", + "description": "Defines the OS configuration.", + "properties": { + "osType": { + "$ref": "#/definitions/OSType", + "description": "The OS Type" + } + }, + "discriminator": "osType", + "required": [ + "osType" + ] + }, + "OSProfile": { + "type": "object", + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters." + }, + "adminPassword": { + "type": "string", + "format": "password", + "description": "Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-secret": true + }, + "osConfiguration": { + "$ref": "#/definitions/OSConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + } + } + }, + "OSType": { + "type": "string", + "description": "The OS Type", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS Type." + }, + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS Type." + } + ] + } + }, + "OsSapConfiguration": { + "type": "object", + "description": "Defines the OS and SAP Configurations for Deployment", + "properties": { + "deployerVmPackages": { + "$ref": "#/definitions/DeployerVmPackages", + "description": "The url and storage account ID where deployer VM packages are uploaded" + }, + "sapFqdn": { + "type": "string", + "description": "The FQDN to set for the SAP system" + } + } + }, + "SAPApplicationServerInstance": { + "type": "object", + "description": "Define the SAP Application Server Instance resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SAPApplicationServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SAPApplicationServerInstanceListResult": { + "type": "object", + "description": "The response of a SAPApplicationServerInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SAPApplicationServerInstance items on this page", + "items": { + "$ref": "#/definitions/SAPApplicationServerInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SAPApplicationServerProperties": { + "type": "object", + "description": "Defines the SAP Application Server instance properties.", + "properties": { + "instanceNo": { + "type": "string", + "description": "Application server Instance Number.", + "readOnly": true + }, + "subnet": { + "type": "string", + "description": "Application server Subnet.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "Application server instance SAP hostname.", + "readOnly": true + }, + "kernelVersion": { + "type": "string", + "description": "Application server instance SAP Kernel Version.", + "readOnly": true + }, + "kernelPatch": { + "type": "string", + "description": "Application server instance SAP Kernel Patch level.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "Application server instance SAP IP Address.", + "readOnly": true + }, + "gatewayPort": { + "type": "integer", + "format": "int64", + "description": "Application server instance gateway Port.", + "readOnly": true + }, + "icmHttpPort": { + "type": "integer", + "format": "int64", + "description": "Application server instance ICM HTTP Port.", + "readOnly": true + }, + "icmHttpsPort": { + "type": "integer", + "format": "int64", + "description": "Application server instance ICM HTTPS Port.", + "readOnly": true + }, + "dispatcherStatus": { + "type": "string", + "description": "Application server instance dispatcher status.", + "readOnly": true + }, + "loadBalancerDetails": { + "$ref": "#/definitions/LoadBalancerDetails", + "description": "The Load Balancer details such as LoadBalancer ID attached to Application Server Virtual Machines", + "readOnly": true + }, + "vmDetails": { + "type": "array", + "description": "The list of virtual machines.", + "items": { + "$ref": "#/definitions/ApplicationServerVmDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/SAPVirtualInstanceStatus", + "description": "Defines the SAP Instance status.", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/SAPHealthState", + "description": "Defines the health of SAP Instances.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/SapVirtualInstanceProvisioningState", + "description": "Defines the provisioning states.", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/SAPVirtualInstanceError", + "description": "Defines the Application Instance errors.", + "readOnly": true + } + } + }, + "SAPAvailabilityZoneDetailsRequest": { + "type": "object", + "description": "The SAP request to get list of availability zones.", + "properties": { + "appLocation": { + "type": "string", + "description": "The geo-location where the SAP resources will be created." + }, + "sapProduct": { + "$ref": "#/definitions/SAPProductType", + "description": "Defines the SAP Product type." + }, + "databaseType": { + "$ref": "#/definitions/SAPDatabaseType", + "description": "The database type. Eg: HANA, DB2, etc" + } + }, + "required": [ + "appLocation", + "sapProduct", + "databaseType" + ] + }, + "SAPAvailabilityZoneDetailsResult": { + "type": "object", + "description": "The list of supported availability zone pairs which are part of SAP HA deployment.", + "properties": { + "availabilityZonePairs": { + "type": "array", + "description": "Gets the list of availability zone pairs.", + "items": { + "$ref": "#/definitions/SAPAvailabilityZonePair" + }, + "x-ms-identifiers": [] + } + } + }, + "SAPAvailabilityZonePair": { + "type": "object", + "description": "The SAP Availability Zone Pair.", + "properties": { + "zoneA": { + "type": "integer", + "format": "int64", + "description": "The zone A." + }, + "zoneB": { + "type": "integer", + "format": "int64", + "description": "The zone B." + } + } + }, + "SAPCentralServerInstance": { + "type": "object", + "description": "Define the SAP Central Services Instance resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SAPCentralServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SAPCentralServerInstanceListResult": { + "type": "object", + "description": "The response of a SAPCentralServerInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SAPCentralServerInstance items on this page", + "items": { + "$ref": "#/definitions/SAPCentralServerInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SAPCentralServerProperties": { + "type": "object", + "description": "Defines the SAP Central Services Instance properties.", + "properties": { + "instanceNo": { + "type": "string", + "description": "The central services instance number.", + "readOnly": true + }, + "subnet": { + "type": "string", + "description": "The central services instance subnet.", + "readOnly": true + }, + "messageServerProperties": { + "$ref": "#/definitions/MessageServerProperties", + "description": "Defines the SAP message server properties." + }, + "enqueueServerProperties": { + "$ref": "#/definitions/EnqueueServerProperties", + "description": "Defines the SAP Enqueue Server properties." + }, + "gatewayServerProperties": { + "$ref": "#/definitions/GatewayServerProperties", + "description": "Defines the SAP Gateway Server properties." + }, + "enqueueReplicationServerProperties": { + "$ref": "#/definitions/EnqueueReplicationServerProperties", + "description": "Defines the SAP Enqueue Replication Server (ERS) properties." + }, + "kernelVersion": { + "type": "string", + "description": "The central services instance Kernel Version.", + "readOnly": true + }, + "kernelPatch": { + "type": "string", + "description": "The central services instance Kernel Patch level.", + "readOnly": true + }, + "loadBalancerDetails": { + "$ref": "#/definitions/LoadBalancerDetails", + "description": "The Load Balancer details such as LoadBalancer ID attached to ASCS Virtual Machines", + "readOnly": true + }, + "vmDetails": { + "type": "array", + "description": "The list of virtual machines corresponding to the Central Services instance.", + "items": { + "$ref": "#/definitions/CentralServerVmDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/SAPVirtualInstanceStatus", + "description": "Defines the SAP Instance status.", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/SAPHealthState", + "description": "Defines the health of SAP Instances.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/SapVirtualInstanceProvisioningState", + "description": "Defines the provisioning states.", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/SAPVirtualInstanceError", + "description": "Defines the errors related to SAP Central Services Instance resource.", + "readOnly": true + } + } + }, + "SAPConfiguration": { + "type": "object", + "description": "The SAP Configuration.", + "properties": { + "configurationType": { + "$ref": "#/definitions/SAPConfigurationType", + "description": "The configuration type. Eg: Deployment/Discovery" + } + }, + "discriminator": "configurationType", + "required": [ + "configurationType" + ] + }, + "SAPConfigurationType": { + "type": "string", + "description": "The configuration Type.", + "enum": [ + "Deployment", + "Discovery", + "DeploymentWithOSConfig" + ], + "x-ms-enum": { + "name": "SAPConfigurationType", + "modelAsString": true, + "values": [ + { + "name": "Deployment", + "value": "Deployment", + "description": "SAP system will be deployed by service. No OS configurations will be done." + }, + { + "name": "Discovery", + "value": "Discovery", + "description": "Existing SAP system will be registered." + }, + { + "name": "DeploymentWithOSConfig", + "value": "DeploymentWithOSConfig", + "description": "SAP system will be deployed by service. OS configurations will be done." + } + ] + } + }, + "SAPDatabaseInstance": { + "type": "object", + "description": "Define the Database resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SAPDatabaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SAPDatabaseInstanceListResult": { + "type": "object", + "description": "The response of a SAPDatabaseInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SAPDatabaseInstance items on this page", + "items": { + "$ref": "#/definitions/SAPDatabaseInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SAPDatabaseProperties": { + "type": "object", + "description": "Defines the Database properties.", + "properties": { + "subnet": { + "type": "string", + "description": "Database subnet.", + "readOnly": true + }, + "databaseSid": { + "type": "string", + "description": "Database SID name.", + "readOnly": true + }, + "databaseType": { + "type": "string", + "description": "Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "Database IP Address.", + "readOnly": true + }, + "loadBalancerDetails": { + "$ref": "#/definitions/LoadBalancerDetails", + "description": "The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines", + "readOnly": true + }, + "vmDetails": { + "type": "array", + "description": "The list of virtual machines corresponding to the Database resource.", + "items": { + "$ref": "#/definitions/DatabaseVmDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/SAPVirtualInstanceStatus", + "description": "Defines the SAP Instance status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/SapVirtualInstanceProvisioningState", + "description": "Defines the provisioning states.", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/SAPVirtualInstanceError", + "description": "Defines the errors related to Database resource.", + "readOnly": true + } + } + }, + "SAPDatabaseScaleMethod": { + "type": "string", + "description": "The database scale method.", + "enum": [ + "ScaleUp" + ], + "x-ms-enum": { + "name": "SAPDatabaseScaleMethod", + "modelAsString": true, + "values": [ + { + "name": "ScaleUp", + "value": "ScaleUp", + "description": "ScaleUp Hana Database deployment type" + } + ] + } + }, + "SAPDatabaseType": { + "type": "string", + "description": "Defines the supported SAP Database types.", + "enum": [ + "HANA", + "DB2" + ], + "x-ms-enum": { + "name": "SAPDatabaseType", + "modelAsString": true, + "values": [ + { + "name": "HANA", + "value": "HANA", + "description": "HANA Database type of SAP system." + }, + { + "name": "DB2", + "value": "DB2", + "description": "DB2 database type of the SAP system." + } + ] + } + }, + "SAPDeploymentType": { + "type": "string", + "description": "The type of SAP deployment, single server or Three tier.", + "enum": [ + "SingleServer", + "ThreeTier" + ], + "x-ms-enum": { + "name": "SAPDeploymentType", + "modelAsString": true, + "values": [ + { + "name": "SingleServer", + "value": "SingleServer", + "description": "SAP Single server deployment type." + }, + { + "name": "ThreeTier", + "value": "ThreeTier", + "description": "SAP Distributed deployment type." + } + ] + } + }, + "SAPDiskConfiguration": { + "type": "object", + "description": "The SAP Disk Configuration contains 'recommended disk' details and list of supported disks detail for a volume type.", + "properties": { + "recommendedConfiguration": { + "$ref": "#/definitions/DiskVolumeConfiguration", + "description": "The recommended disk details for a given VM Sku." + }, + "supportedConfigurations": { + "type": "array", + "description": "The list of supported disks for a given VM Sku.", + "items": { + "$ref": "#/definitions/DiskDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "SAPDiskConfigurationsRequest": { + "type": "object", + "description": "The SAP request to get list of disk configurations.", + "properties": { + "appLocation": { + "type": "string", + "description": "The geo-location where the SAP resources will be created." + }, + "environment": { + "$ref": "#/definitions/SAPEnvironmentType", + "description": "Defines the environment type - Production/Non Production." + }, + "sapProduct": { + "$ref": "#/definitions/SAPProductType", + "description": "Defines the SAP Product type." + }, + "databaseType": { + "$ref": "#/definitions/SAPDatabaseType", + "description": "The database type. Eg: HANA, DB2, etc" + }, + "deploymentType": { + "$ref": "#/definitions/SAPDeploymentType", + "description": "The deployment type. Eg: SingleServer/ThreeTier" + }, + "dbVmSku": { + "type": "string", + "description": "The VM SKU for database instance." + } + }, + "required": [ + "appLocation", + "environment", + "sapProduct", + "databaseType", + "deploymentType", + "dbVmSku" + ] + }, + "SAPDiskConfigurationsResult": { + "type": "object", + "description": "The list of disk configuration for vmSku which are part of SAP deployment.", + "properties": { + "volumeConfigurations": { + "type": "object", + "description": "The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup'].", + "additionalProperties": { + "$ref": "#/definitions/SAPDiskConfiguration" + } + } + } + }, + "SAPEnvironmentType": { + "type": "string", + "description": "Defines the environment type - Production/Non Production.", + "enum": [ + "NonProd", + "Prod" + ], + "x-ms-enum": { + "name": "SAPEnvironmentType", + "modelAsString": true, + "values": [ + { + "name": "NonProd", + "value": "NonProd", + "description": "Non Production SAP system." + }, + { + "name": "Prod", + "value": "Prod", + "description": "Production SAP system." + } + ] + } + }, + "SAPHealthState": { + "type": "string", + "description": "Defines the health of SAP Instances.", + "enum": [ + "Unknown", + "Healthy", + "Unhealthy", + "Degraded" + ], + "x-ms-enum": { + "name": "SAPHealthState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "SAP System health is unknown." + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "SAP System health is healthy." + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "SAP System is unhealthy." + }, + { + "name": "Degraded", + "value": "Degraded", + "description": "SAP System health is degraded." + } + ] + } + }, + "SAPHighAvailabilityType": { + "type": "string", + "description": "The high availability type (AvailabilitySet or AvailabilityZone).", + "enum": [ + "AvailabilitySet", + "AvailabilityZone" + ], + "x-ms-enum": { + "name": "SAPHighAvailabilityType", + "modelAsString": true, + "values": [ + { + "name": "AvailabilitySet", + "value": "AvailabilitySet", + "description": "HA deployment with availability sets." + }, + { + "name": "AvailabilityZone", + "value": "AvailabilityZone", + "description": "HA deployment with availability zones." + } + ] + } + }, + "SAPInstallWithoutOSConfigSoftwareConfiguration": { + "type": "object", + "description": "The SAP Software configuration Input when the software is to be installed by service without OS Configurations", + "properties": { + "bomUrl": { + "type": "string", + "description": "The URL to the SAP Build of Materials(BOM) file." + }, + "sapBitsStorageAccountId": { + "type": "string", + "description": "The SAP bits storage account id." + }, + "softwareVersion": { + "type": "string", + "description": "The software version to install." + }, + "highAvailabilitySoftwareConfiguration": { + "$ref": "#/definitions/HighAvailabilitySoftwareConfiguration", + "description": "Gets or sets the HA software configuration." + } + }, + "required": [ + "bomUrl", + "sapBitsStorageAccountId", + "softwareVersion" + ], + "allOf": [ + { + "$ref": "#/definitions/SoftwareConfiguration" + } + ], + "x-ms-discriminator-value": "SAPInstallWithoutOSConfig" + }, + "SAPProductType": { + "type": "string", + "description": "Defines the SAP Product type.", + "enum": [ + "ECC", + "S4HANA", + "Other" + ], + "x-ms-enum": { + "name": "SAPProductType", + "modelAsString": true, + "values": [ + { + "name": "ECC", + "value": "ECC", + "description": "SAP Product ECC." + }, + { + "name": "S4HANA", + "value": "S4HANA", + "description": "SAP Product S4HANA." + }, + { + "name": "Other", + "value": "Other", + "description": "SAP Products other than the ones listed." + } + ] + } + }, + "SAPSizingRecommendationRequest": { + "type": "object", + "description": "The SAP Sizing Recommendation request.", + "properties": { + "appLocation": { + "type": "string", + "description": "The geo-location where the resource is to be created." + }, + "environment": { + "$ref": "#/definitions/SAPEnvironmentType", + "description": "Defines the environment type - Production/Non Production." + }, + "sapProduct": { + "$ref": "#/definitions/SAPProductType", + "description": "Defines the SAP Product type." + }, + "deploymentType": { + "$ref": "#/definitions/SAPDeploymentType", + "description": "The deployment type. Eg: SingleServer/ThreeTier" + }, + "saps": { + "type": "integer", + "format": "int64", + "description": "The SAP Application Performance Standard measurement." + }, + "dbMemory": { + "type": "integer", + "format": "int64", + "description": "The database memory configuration." + }, + "databaseType": { + "$ref": "#/definitions/SAPDatabaseType", + "description": "The database type." + }, + "dbScaleMethod": { + "$ref": "#/definitions/SAPDatabaseScaleMethod", + "description": "The DB scale method." + }, + "highAvailabilityType": { + "$ref": "#/definitions/SAPHighAvailabilityType", + "description": "The high availability type." + } + }, + "required": [ + "appLocation", + "environment", + "sapProduct", + "deploymentType", + "saps", + "dbMemory", + "databaseType" + ] + }, + "SAPSizingRecommendationResult": { + "type": "object", + "description": "The SAP sizing recommendation result.", + "properties": { + "deploymentType": { + "$ref": "#/definitions/SAPDeploymentType", + "description": "The deployment type. Eg: SingleServer/ThreeTier" + } + }, + "discriminator": "deploymentType", + "required": [ + "deploymentType" + ] + }, + "SAPSoftwareInstallationType": { + "type": "string", + "description": "The SAP software installation Type.", + "enum": [ + "ServiceInitiated", + "SAPInstallWithoutOSConfig", + "External" + ], + "x-ms-enum": { + "name": "SAPSoftwareInstallationType", + "modelAsString": true, + "values": [ + { + "name": "ServiceInitiated", + "value": "ServiceInitiated", + "description": "SAP Install managed by service." + }, + { + "name": "SAPInstallWithoutOSConfig", + "value": "SAPInstallWithoutOSConfig", + "description": "SAP Install without OS Config." + }, + { + "name": "External", + "value": "External", + "description": "External software installation type." + } + ] + } + }, + "SAPSupportedResourceSkusResult": { + "type": "object", + "description": "The list of supported SKUs for different resources which are part of SAP deployment.", + "properties": { + "supportedSkus": { + "type": "array", + "description": "Gets the list of SAP supported SKUs.", + "items": { + "$ref": "#/definitions/SAPSupportedSku" + }, + "x-ms-identifiers": [] + } + } + }, + "SAPSupportedSku": { + "type": "object", + "description": "The SAP supported SKU.", + "properties": { + "vmSku": { + "type": "string", + "description": "The VM Sku." + }, + "isAppServerCertified": { + "type": "boolean", + "description": "True if the Sku is certified for App server in the SAP system." + }, + "isDatabaseCertified": { + "type": "boolean", + "description": "True if the Sku is certified for Database server in the SAP system." + } + } + }, + "SAPSupportedSkusRequest": { + "type": "object", + "description": "The SAP request to get list of supported SKUs.", + "properties": { + "appLocation": { + "type": "string", + "description": "The geo-location where the resource is to be created." + }, + "environment": { + "$ref": "#/definitions/SAPEnvironmentType", + "description": "Defines the environment type - Production/Non Production." + }, + "sapProduct": { + "$ref": "#/definitions/SAPProductType", + "description": "Defines the SAP Product type." + }, + "deploymentType": { + "$ref": "#/definitions/SAPDeploymentType", + "description": "The deployment type. Eg: SingleServer/ThreeTier" + }, + "databaseType": { + "$ref": "#/definitions/SAPDatabaseType", + "description": "The database type. Eg: HANA, DB2, etc" + }, + "highAvailabilityType": { + "$ref": "#/definitions/SAPHighAvailabilityType", + "description": "The high availability type." + } + }, + "required": [ + "appLocation", + "environment", + "sapProduct", + "deploymentType", + "databaseType" + ] + }, + "SAPVirtualInstance": { + "type": "object", + "description": "Define the Virtual Instance for SAP solutions resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SAPVirtualInstanceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SAPVirtualInstanceError": { + "type": "object", + "description": "An error response from the Virtual Instance for SAP Workload service.", + "properties": { + "properties": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The Virtual Instance for SAP error body." + } + } + }, + "SAPVirtualInstanceListResult": { + "type": "object", + "description": "The response of a SAPVirtualInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SAPVirtualInstance items on this page", + "items": { + "$ref": "#/definitions/SAPVirtualInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SAPVirtualInstanceProperties": { + "type": "object", + "description": "Defines the Virtual Instance for SAP solutions resource properties.", + "properties": { + "environment": { + "$ref": "#/definitions/SAPEnvironmentType", + "description": "Defines the environment type - Production/Non Production.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sapProduct": { + "$ref": "#/definitions/SAPProductType", + "description": "Defines the SAP Product type.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedResourcesNetworkAccessType": { + "$ref": "#/definitions/ManagedResourcesNetworkAccessType", + "description": "Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228" + }, + "configuration": { + "$ref": "#/definitions/SAPConfiguration", + "description": "Defines if the SAP system is being created using Azure Center for SAP solutions (ACSS) or if an existing SAP system is being registered with ACSS" + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedRGConfiguration", + "description": "Managed resource group configuration" + }, + "status": { + "$ref": "#/definitions/SAPVirtualInstanceStatus", + "description": "Defines the SAP Instance status.", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/SAPHealthState", + "description": "Defines the health of SAP Instances.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/SAPVirtualInstanceState", + "description": "Defines the Virtual Instance for SAP state.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/SapVirtualInstanceProvisioningState", + "description": "Defines the provisioning states.", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/SAPVirtualInstanceError", + "description": "Indicates any errors on the Virtual Instance for SAP solutions resource.", + "readOnly": true + } + }, + "required": [ + "environment", + "sapProduct", + "configuration" + ] + }, + "SAPVirtualInstanceState": { + "type": "string", + "description": "Defines the Virtual Instance for SAP state.", + "enum": [ + "InfrastructureDeploymentPending", + "InfrastructureDeploymentInProgress", + "InfrastructureDeploymentFailed", + "SoftwareInstallationPending", + "SoftwareInstallationInProgress", + "SoftwareInstallationFailed", + "SoftwareDetectionInProgress", + "SoftwareDetectionFailed", + "DiscoveryPending", + "DiscoveryInProgress", + "DiscoveryFailed", + "RegistrationComplete", + "ACSSInstallationBlocked" + ], + "x-ms-enum": { + "name": "SAPVirtualInstanceState", + "modelAsString": true, + "values": [ + { + "name": "InfrastructureDeploymentPending", + "value": "InfrastructureDeploymentPending", + "description": "Infrastructure is not yet deployed." + }, + { + "name": "InfrastructureDeploymentInProgress", + "value": "InfrastructureDeploymentInProgress", + "description": "Infrastructure deployment is in progress." + }, + { + "name": "InfrastructureDeploymentFailed", + "value": "InfrastructureDeploymentFailed", + "description": "Infrastructure deployment has failed." + }, + { + "name": "SoftwareInstallationPending", + "value": "SoftwareInstallationPending", + "description": "Infrastructure deployment is successful. Software installation is pending." + }, + { + "name": "SoftwareInstallationInProgress", + "value": "SoftwareInstallationInProgress", + "description": "Software installation is in progress." + }, + { + "name": "SoftwareInstallationFailed", + "value": "SoftwareInstallationFailed", + "description": "Software installation failed." + }, + { + "name": "SoftwareDetectionInProgress", + "value": "SoftwareDetectionInProgress", + "description": "Software detection is in progress." + }, + { + "name": "SoftwareDetectionFailed", + "value": "SoftwareDetectionFailed", + "description": "Software detection failed." + }, + { + "name": "DiscoveryPending", + "value": "DiscoveryPending", + "description": "Registration has not started." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "Registration is in progress." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "Registration has failed." + }, + { + "name": "RegistrationComplete", + "value": "RegistrationComplete", + "description": "Registration is complete." + }, + { + "name": "ACSSInstallationBlocked", + "value": "ACSSInstallationBlocked", + "description": "ACSS installation cannot proceed." + } + ] + } + }, + "SAPVirtualInstanceStatus": { + "type": "string", + "description": "Defines the SAP Instance status.", + "enum": [ + "Starting", + "Running", + "Stopping", + "Offline", + "PartiallyRunning", + "Unavailable", + "SoftShutdown" + ], + "x-ms-enum": { + "name": "SAPVirtualInstanceStatus", + "modelAsString": true, + "values": [ + { + "name": "Starting", + "value": "Starting", + "description": "SAP system is getting started." + }, + { + "name": "Running", + "value": "Running", + "description": "SAP system is running." + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "SAP system is being stopped." + }, + { + "name": "Offline", + "value": "Offline", + "description": "SAP system is offline." + }, + { + "name": "PartiallyRunning", + "value": "PartiallyRunning", + "description": "SAP system is partially running." + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "SAP system status is unavailable." + }, + { + "name": "SoftShutdown", + "value": "SoftShutdown", + "description": "Soft shutdown of SAP system is initiated." + } + ] + } + }, + "SapVirtualInstanceProvisioningState": { + "type": "string", + "description": "Defines the provisioning states.", + "enum": [ + "Succeeded", + "Updating", + "Creating", + "Failed", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "SapVirtualInstanceProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "ACSS succeeded provisioning state." + }, + { + "name": "Updating", + "value": "Updating", + "description": "ACSS updating provisioning state." + }, + { + "name": "Creating", + "value": "Creating", + "description": "ACSS Creating provisioning state." + }, + { + "name": "Failed", + "value": "Failed", + "description": "ACSS Failed provisioning state." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "ACSS Deleting provisioning state." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "ACSS Canceled provisioning state." + } + ] + }, + "readOnly": true + }, + "ServiceInitiatedSoftwareConfiguration": { + "type": "object", + "description": "The SAP Software configuration Input when the software is to be installed by service.", + "properties": { + "bomUrl": { + "type": "string", + "description": "The URL to the SAP Build of Materials(BOM) file." + }, + "softwareVersion": { + "type": "string", + "description": "The software version to install." + }, + "sapBitsStorageAccountId": { + "type": "string", + "description": "The SAP bits storage account id." + }, + "sapFqdn": { + "type": "string", + "description": "The FQDN to set for the SAP system during install." + }, + "sshPrivateKey": { + "type": "string", + "format": "password", + "description": "The SSH private key.", + "x-ms-secret": true + }, + "highAvailabilitySoftwareConfiguration": { + "$ref": "#/definitions/HighAvailabilitySoftwareConfiguration", + "description": "Gets or sets the HA software configuration." + } + }, + "required": [ + "bomUrl", + "softwareVersion", + "sapBitsStorageAccountId", + "sapFqdn", + "sshPrivateKey" + ], + "allOf": [ + { + "$ref": "#/definitions/SoftwareConfiguration" + } + ], + "x-ms-discriminator-value": "ServiceInitiated" + }, + "SharedStorageResourceNames": { + "type": "object", + "description": "The resource names object for shared storage.", + "properties": { + "sharedStorageAccountName": { + "type": "string", + "description": "The full name of the shared storage account. If it is not provided, it will be defaulted to {SID}nfs{guid of 15 chars}." + }, + "sharedStorageAccountPrivateEndPointName": { + "type": "string", + "description": "The full name of private end point for the shared storage account. If it is not provided, it will be defaulted to {storageAccountName}_pe" + } + } + }, + "SingleServerConfiguration": { + "type": "object", + "description": "Gets or sets the single server configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409)", + "properties": { + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "Network configuration for the server" + }, + "databaseType": { + "$ref": "#/definitions/SAPDatabaseType", + "description": "The database type." + }, + "subnetId": { + "type": "string", + "description": "The subnet id." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "description": "Gets or sets the virtual machine configuration." + }, + "dbDiskConfiguration": { + "$ref": "#/definitions/DiskConfiguration", + "description": "Gets or sets the disk configuration." + }, + "customResourceNames": { + "$ref": "#/definitions/SingleServerCustomResourceNames", + "description": "The set of custom names to be used for underlying azure resources that are part of the SAP system." + } + }, + "required": [ + "subnetId", + "virtualMachineConfiguration" + ], + "allOf": [ + { + "$ref": "#/definitions/InfrastructureConfiguration" + } + ], + "x-ms-discriminator-value": "SingleServer" + }, + "SingleServerCustomResourceNames": { + "type": "object", + "description": "The resource-names input to specify custom names for underlying azure resources that are part of a single server SAP system.", + "properties": { + "namingPatternType": { + "$ref": "#/definitions/NamingPatternType", + "description": "The naming pattern type." + } + }, + "discriminator": "namingPatternType", + "required": [ + "namingPatternType" + ] + }, + "SingleServerFullResourceNames": { + "type": "object", + "description": "The resource name object where the specified values will be full resource names of the corresponding resources in a single server SAP system.", + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineResourceNames", + "description": "The resource names object for virtual machine and related resources." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SingleServerCustomResourceNames" + } + ], + "x-ms-discriminator-value": "FullResourceName" + }, + "SingleServerRecommendationResult": { + "type": "object", + "description": "The recommended configuration for a single server SAP system.", + "properties": { + "vmSku": { + "type": "string", + "description": "The recommended VM SKU for single server." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SAPSizingRecommendationResult" + } + ], + "x-ms-discriminator-value": "SingleServer" + }, + "SkipFileShareConfiguration": { + "type": "object", + "description": "Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required.", + "allOf": [ + { + "$ref": "#/definitions/FileShareConfiguration" + } + ], + "x-ms-discriminator-value": "Skip" + }, + "SoftwareConfiguration": { + "type": "object", + "description": "The SAP Software configuration Input.", + "properties": { + "softwareInstallationType": { + "$ref": "#/definitions/SAPSoftwareInstallationType", + "description": "The SAP software installation type." + } + }, + "discriminator": "softwareInstallationType", + "required": [ + "softwareInstallationType" + ] + }, + "SshConfiguration": { + "type": "object", + "description": "SSH configuration for Linux based VMs running on Azure", + "properties": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [] + } + } + }, + "SshKeyPair": { + "type": "object", + "description": "The SSH Key-pair used to authenticate with the VM. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).", + "properties": { + "publicKey": { + "type": "string", + "description": "SSH public key" + }, + "privateKey": { + "type": "string", + "format": "password", + "description": "SSH private key.", + "x-ms-secret": true + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.", + "properties": { + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "StartRequest": { + "type": "object", + "description": "Start SAP instance(s) request body.", + "properties": { + "startVm": { + "type": "boolean", + "description": "The boolean value indicates whether to start the virtual machines before starting the SAP instances.", + "default": false + } + } + }, + "StopRequest": { + "type": "object", + "description": "Stop SAP instance(s) request body.", + "properties": { + "softStopTimeoutSeconds": { + "type": "integer", + "format": "int64", + "description": "This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. hard stop.", + "default": 0 + }, + "deallocateVm": { + "type": "boolean", + "description": "The boolean value indicates whether to Stop and deallocate the virtual machines along with the SAP instances.", + "default": false + } + } + }, + "StorageConfiguration": { + "type": "object", + "description": "Gets or sets the storage configuration.", + "properties": { + "transportFileShareConfiguration": { + "$ref": "#/definitions/FileShareConfiguration", + "description": "The properties of the transport directory attached to the VIS. The default for transportFileShareConfiguration is the createAndMount flow if storage configuration is missing." + } + } + }, + "StorageInformation": { + "type": "object", + "description": "Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified resource ID for the storage account.", + "readOnly": true + } + } + }, + "ThreeTierConfiguration": { + "type": "object", + "description": "Gets or sets the three tier SAP configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409)", + "properties": { + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "Network configuration common to all servers" + }, + "centralServer": { + "$ref": "#/definitions/CentralServerConfiguration", + "description": "The central server configuration." + }, + "applicationServer": { + "$ref": "#/definitions/ApplicationServerConfiguration", + "description": "The application server configuration." + }, + "databaseServer": { + "$ref": "#/definitions/DatabaseConfiguration", + "description": "The database configuration." + }, + "highAvailabilityConfig": { + "$ref": "#/definitions/HighAvailabilityConfiguration", + "description": "The high availability configuration." + }, + "storageConfiguration": { + "$ref": "#/definitions/StorageConfiguration", + "description": "The storage configuration." + }, + "customResourceNames": { + "$ref": "#/definitions/ThreeTierCustomResourceNames", + "description": "The set of custom names to be used for underlying azure resources that are part of the SAP system." + } + }, + "required": [ + "centralServer", + "applicationServer", + "databaseServer" + ], + "allOf": [ + { + "$ref": "#/definitions/InfrastructureConfiguration" + } + ], + "x-ms-discriminator-value": "ThreeTier" + }, + "ThreeTierCustomResourceNames": { + "type": "object", + "description": "The resource-names input to specify custom names for underlying azure resources that are part of a three tier SAP system.", + "properties": { + "namingPatternType": { + "$ref": "#/definitions/NamingPatternType", + "description": "The pattern type to be used for resource naming." + } + }, + "discriminator": "namingPatternType", + "required": [ + "namingPatternType" + ] + }, + "ThreeTierFullResourceNames": { + "type": "object", + "description": "The resource name object where the specified values will be full resource names of the corresponding resources in a three tier SAP system.", + "properties": { + "centralServer": { + "$ref": "#/definitions/CentralServerFullResourceNames", + "description": "The full resource names object for central server layer resources." + }, + "applicationServer": { + "$ref": "#/definitions/ApplicationServerFullResourceNames", + "description": "The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer." + }, + "databaseServer": { + "$ref": "#/definitions/DatabaseServerFullResourceNames", + "description": "The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer." + }, + "sharedStorage": { + "$ref": "#/definitions/SharedStorageResourceNames", + "description": "The resource names object for shared storage." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ThreeTierCustomResourceNames" + } + ], + "x-ms-discriminator-value": "FullResourceName" + }, + "ThreeTierRecommendationResult": { + "type": "object", + "description": "The recommended configuration for a three tier SAP system.", + "properties": { + "dbVmSku": { + "type": "string", + "description": "The database VM SKU." + }, + "databaseInstanceCount": { + "type": "integer", + "format": "int64", + "description": "The database server instance count." + }, + "centralServerVmSku": { + "type": "string", + "description": "The central server VM SKU." + }, + "centralServerInstanceCount": { + "type": "integer", + "format": "int64", + "description": "The central server instance count." + }, + "applicationServerVmSku": { + "type": "string", + "description": "The application server VM SKU." + }, + "applicationServerInstanceCount": { + "type": "integer", + "format": "int64", + "description": "The application server instance count." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SAPSizingRecommendationResult" + } + ], + "x-ms-discriminator-value": "ThreeTier" + }, + "UpdateSAPApplicationInstanceRequest": { + "type": "object", + "description": "Defines the request body for updating SAP Application Instance.", + "properties": { + "tags": { + "type": "object", + "description": "Gets or sets the Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpdateSAPCentralInstanceRequest": { + "type": "object", + "description": "Defines the request body for updating SAP Central Instance.", + "properties": { + "tags": { + "type": "object", + "description": "Gets or sets the Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpdateSAPDatabaseInstanceRequest": { + "type": "object", + "description": "Defines the request body for updating SAP Database Instance.", + "properties": { + "tags": { + "type": "object", + "description": "Gets or sets the Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpdateSAPVirtualInstanceProperties": { + "type": "object", + "description": "Defines the update request body properties for updating Virtual Instance for SAP.", + "properties": { + "managedResourcesNetworkAccessType": { + "$ref": "#/definitions/ManagedResourcesNetworkAccessType", + "description": "Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228" + } + } + }, + "UpdateSAPVirtualInstanceRequest": { + "type": "object", + "description": "Defines the request body for updating Virtual Instance for SAP.", + "properties": { + "tags": { + "type": "object", + "description": "Gets or sets the Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "Managed service identity (user assigned identities)" + }, + "properties": { + "$ref": "#/definitions/UpdateSAPVirtualInstanceProperties", + "description": "The update properties." + } + } + }, + "VirtualMachineConfiguration": { + "type": "object", + "description": "Defines the virtual machine configuration.", + "properties": { + "vmSize": { + "type": "string", + "description": "The virtual machine size." + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "The OS profile." + } + }, + "required": [ + "vmSize", + "imageReference", + "osProfile" + ] + }, + "VirtualMachineResourceNames": { + "type": "object", + "description": "The resource names object for virtual machine and related resources.", + "properties": { + "vmName": { + "type": "string", + "description": "The full name for virtual machine. The length of this field can be upto 64 characters. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}vm. In case of HA-AvZone systems, default name will be {SID}{app/ascs/db}z{a/b}vm with an incrementor at the end in case of more than 1 vm per layer. For distributed and HA-AvSet systems, default name will be {SID}{app/ascs/db}vm with an incrementor at the end in case of more than 1 vm per layer." + }, + "hostName": { + "type": "string", + "description": "The full name for virtual-machine's host (computer name). Currently, ACSS only supports host names which are less than or equal to 13 characters long. If this value is not provided, vmName will be used as host name." + }, + "networkInterfaces": { + "type": "array", + "description": "The list of network interface name objects for the selected virtual machine. Currently, only one network interface is supported per virtual machine.", + "items": { + "$ref": "#/definitions/NetworkInterfaceResourceNames" + }, + "x-ms-identifiers": [] + }, + "osDiskName": { + "type": "string", + "description": "The full name for OS disk attached to the VM. If this value is not provided, it will be named by ARM as per its default naming standards (prefixed with vm name). There is only one OS disk attached per Virtual Machine." + }, + "dataDiskNames": { + "type": "object", + "description": "The full resource names for virtual machine data disks. This is a dictionary containing list of names of data disks per volume. Currently supported volumes for database layer are ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os', 'backup']. For application and cs layers, only 'default' volume is supported", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + } + } + }, + "WindowsConfiguration": { + "type": "object", + "description": "Specifies Windows operating system settings on the virtual machine.", + "allOf": [ + { + "$ref": "#/definitions/OSConfiguration" + } + ], + "x-ms-discriminator-value": "Windows" + } + }, + "parameters": {} +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Create.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Create.json new file mode 100644 index 000000000000..c86c63c9904f --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Unknown", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Create", + "title": "SAPApplicationServerInstances_Create" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json new file mode 100644 index 000000000000..b5826dc6bf76 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_CreateForHaWithAvailabilitySet.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Standby", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Unknown", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Standby", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Create", + "title": "Create SAP Application Server Instances for HA System with Availability Set" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Delete.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Delete.json new file mode 100644 index 000000000000..4d69aaa1d07f --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapApplicationServerInstances_Delete", + "title": "SAPApplicationServerInstances_Delete" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Get.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Get.json new file mode 100644 index 000000000000..90416e6235ce --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Get", + "title": "SAPApplicationServerInstances_Get" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_ListBySapVirtualInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_ListBySapVirtualInstance.json new file mode 100644 index 000000000000..f1d7b89e1a35 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_ListBySapVirtualInstance.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "app02", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app02", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapApplicationServerInstances_List", + "title": "SapApplicationServerInstances List By SAP Virtual Instance" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstance.json new file mode 100644 index 000000000000..2894df1f0e30 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Start", + "title": "Start the SAP Application Server Instance." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstanceVM.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstanceVM.json new file mode 100644 index 000000000000..0cd280b57a6e --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StartInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "startVm": true + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Start", + "title": "Start Virtual Machine and the SAP Application Server Instance on it." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstance.json new file mode 100644 index 000000000000..7024658de872 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstance.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Stop the SAP Application Server Instance" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceInfrastructure.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceInfrastructure.json new file mode 100644 index 000000000000..601efcb3619f --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceInfrastructure.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Stop the SAP Application Server Instance and it's infrastructure." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoft.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoft.json new file mode 100644 index 000000000000..8f6a47005e78 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoft.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Soft Stop the SAP Application Server Instance" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json new file mode 100644 index 000000000000..f17a194f9843 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_StopInstanceSoftInfrastructure.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapApplicationServerInstances_Stop", + "title": "Soft Stop the SAP Application Server Instance and it's infrastructure." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Update.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Update.json new file mode 100644 index 000000000000..eb6613685f98 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapApplicationServerInstances_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "applicationInstanceName": "app01", + "properties": { + "tags": { + "tag1": "value1" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "app01", + "type": "Microsoft.Workloads/sapVirtualInstances/applicationInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/app01", + "location": "westcentralus", + "properties": { + "dispatcherStatus": "Running", + "errors": null, + "gatewayPort": 3300, + "health": "Healthy", + "hostname": "vh-nw1", + "icmHttpPort": 3312, + "icmHttpsPort": 3313, + "instanceNo": "01", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Active", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/app01-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapApplicationServerInstances_Update", + "title": "SAPApplicationServerInstances_Update" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Create.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Create.json new file mode 100644 index 000000000000..5e5f15aeb0a4 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Create.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Create", + "title": "SapCentralServerInstances_Create" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_CreateForHaWithAvailabilitySet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_CreateForHaWithAvailabilitySet.json new file mode 100644 index 000000000000..d623a14b4172 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_CreateForHaWithAvailabilitySet.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-ASCS-loadBalancer" + }, + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/cs-ASCS-loadBalancer" + }, + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm1" + }, + { + "type": "Primary", + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm2" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Create", + "title": "Create SAP Central Instances for HA System with Availability Set" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Delete.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Delete.json new file mode 100644 index 000000000000..35d8936d385f --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapCentralServerInstances_Delete", + "title": "SapCentralServerInstances_Delete" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Get.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Get.json new file mode 100644 index 000000000000..467031c34804 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Unknown", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Degraded", + "port": 3300 + }, + "health": "Unknown", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Unhealthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Get", + "title": "SapCentralServerInstances_Get" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstance.json new file mode 100644 index 000000000000..a9890d000e37 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Start", + "title": "Start the SAP Central Services Instance" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstanceVM.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstanceVM.json new file mode 100644 index 000000000000..94931a5fc984 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StartInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "startVm": true + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Start", + "title": "Start the virtual machine(s) and the SAP central services instance on it." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstance.json new file mode 100644 index 000000000000..9ced949f11cc --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstance.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 1200 + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Stop", + "title": "Stop the SAP Central Services Instance." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstanceVM.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstanceVM.json new file mode 100644 index 000000000000..2a78cdfe9321 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_StopInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapCentralServerInstances_Stop", + "title": "Stop the SAP Central Services Instance and its underlying Virtual Machine(s)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Update.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Update.json new file mode 100644 index 000000000000..3e3132fd30eb --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralInstances_Update.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "tags": { + "tag1": "value1" + } + }, + "centralInstanceName": "centralServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapCentralServerInstances_Update", + "title": "SapCentralServerInstances_Update" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralServerInstances_ListBySapVirtualInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralServerInstances_ListBySapVirtualInstance.json new file mode 100644 index 000000000000..1f651e0c89cd --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapCentralServerInstances_ListBySapVirtualInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "centralServer", + "type": "Microsoft.Workloads/sapVirtualInstances/centralInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/centralInstances/centralServer", + "location": "westcentralus", + "properties": { + "enqueueReplicationServerProperties": { + "ersVersion": "EnqueueReplicator1", + "health": "Healthy", + "hostname": "vh-ers1", + "instanceNo": "00", + "ipAddress": "10.0.0.5", + "kernelPatch": "patch 300", + "kernelVersion": "777" + }, + "enqueueServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "ipAddress": "10.0.0.5", + "port": 3600 + }, + "errors": null, + "gatewayServerProperties": { + "health": "Healthy", + "port": 3300 + }, + "health": "Healthy", + "instanceNo": "00", + "kernelPatch": "patch 300", + "kernelVersion": "777", + "messageServerProperties": { + "health": "Healthy", + "hostname": "vh-ascs1", + "httpPort": 8100, + "httpsPort": 44400, + "internalMsPort": 3900, + "ipAddress": "10.0.0.5", + "msPort": 3600 + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/SAP-E2ETest-rg/providers/Microsoft.Network/virtualNetworks/loop-test-vnet/subnets/loopsubnet", + "vmDetails": [ + { + "type": "Primary", + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/cs-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapCentralServerInstances_List", + "title": "SAPCentralInstances List by SAP virtual instance" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Create.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Create.json new file mode 100644 index 000000000000..1e6cdc400ce3 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Create.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Create", + "title": "SAPDatabaseInstances_Create" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json new file mode 100644 index 000000000000..261d1bcc0b79 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_CreateForHaWithAvailabilitySet.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": {}, + "tags": {} + }, + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/db-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "loadBalancerDetails": { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/loadBalancers/db-loadBalancer" + }, + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "storageDetails": [ + { + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/nfsstorageaccount" + } + ], + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Create", + "title": "Create SAP Database Instances for HA System with Availability Set" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Delete.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Delete.json new file mode 100644 index 000000000000..93f99f8c9e52 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapDatabaseInstances_Delete", + "title": "SAPDatabaseInstances_Delete" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Get.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Get.json new file mode 100644 index 000000000000..b5a26695c3ec --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Get", + "title": "SAPDatabaseInstances_Get" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_List.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_List.json new file mode 100644 index 000000000000..4c3f12d64c0a --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapDatabaseInstances_List", + "title": "SAPDatabaseInstances list by SAP virtual instance" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstance.json new file mode 100644 index 000000000000..6232f364c6b8 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Start", + "title": "Start the database instance of the SAP system." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstanceVM.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstanceVM.json new file mode 100644 index 000000000000..94f795130ab8 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StartInstanceVM.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "startVm": true + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Start", + "title": "Start Virtual Machine and the database instance of the SAP system on it." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstance.json new file mode 100644 index 000000000000..745b05662962 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstance.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 0 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Stop the database instance of the SAP system." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoft.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoft.json new file mode 100644 index 000000000000..1f12bbc33403 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoft.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 300 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Soft Stop the database instance of the SAP system." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoftVM.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoftVM.json new file mode 100644 index 000000000000..7dc4e5d7caad --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceSoftVM.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 300 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Soft Stop the database instance of the SAP system and the underlying Virtual Machine(s)." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceVM.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceVM.json new file mode 100644 index 000000000000..0663f34f7568 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_StopInstanceVM.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 0 + }, + "databaseInstanceName": "db0", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "db0", + "endTime": "2022-11-01T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/applicationInstances/db0", + "startTime": "2022-11-01T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://eastus2euap.management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Workloads/locations/NORTHEUROPE/operationStatuses/sample-op-status?api-version=2024-09-01" + } + } + }, + "operationId": "SapDatabaseInstances_Stop", + "title": "Stop the database instance of the SAP system and the underlying Virtual Machine(s)." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Update.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Update.json new file mode 100644 index 000000000000..78ae2e523795 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapDatabaseInstances_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "tags": { + "key1": "value1" + } + }, + "databaseInstanceName": "databaseServer", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "name": "databaseServer", + "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer", + "location": "westcentralus", + "properties": { + "databaseSid": "X00", + "databaseType": "hdb", + "errors": null, + "ipAddress": "10.0.0.5", + "provisioningState": "Succeeded", + "status": "Running", + "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmDetails": [ + { + "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm" + } + ] + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapDatabaseInstances_Update", + "title": "SAPDatabaseInstances_Update" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectDS.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectDS.json new file mode 100644 index 000000000000..55660e83bfeb --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectDS.json @@ -0,0 +1,336 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "{{resourcegrp}}", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": { + "created by": "azureuser" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + }, + "201": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on a Distributed System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilitySet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilitySet.json new file mode 100644 index 000000000000..f3c3389371e1 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilitySet.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on an HA System with Availability Set" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilityZone.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilityZone.json new file mode 100644 index 000000000000..14c52ae8f652 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectHaAvailabilityZone.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on an HA System with Availability Zone" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectSingleServer.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectSingleServer.json new file mode 100644 index 000000000000..49bbc416b82c --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateDetectSingleServer.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "NonProd", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + }, + "softwareConfiguration": { + "centralServerVmId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "softwareInstallationType": "External" + } + }, + "environment": "NonProd", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareDetectionInProgress" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Detect SAP Software Installation on a Single Server System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDS.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDS.json new file mode 100644 index 000000000000..a766e5cf0b3d --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDS.json @@ -0,0 +1,340 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for Distributed System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json new file mode 100644 index 000000000000..aa5ffd70e77a --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsDSRecommended.json @@ -0,0 +1,454 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configuration for Distributed System (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json new file mode 100644 index 000000000000..7331c3e6f9ed --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilitySetRecommended.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configuration for HA System with Availability Set (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json new file mode 100644 index 000000000000..73abfbed0309 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsHaAvailabilityZoneRecommended.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "diskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configuration for HA System with Availability Zone (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json new file mode 100644 index 000000000000..1efe1d3bef00 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraDiskOsSingleServerRecommended.json @@ -0,0 +1,314 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "dbDiskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "dbDiskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "dbDiskConfiguration": { + "diskVolumeConfigurations": { + "backup": { + "count": 2, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "hana/data": { + "count": 4, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/log": { + "count": 3, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + }, + "hana/shared": { + "count": 1, + "sizeGB": 256, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "os": { + "count": 1, + "sizeGB": 64, + "sku": { + "name": "StandardSSD_LRS" + } + }, + "usr/sap": { + "count": 1, + "sizeGB": 128, + "sku": { + "name": "Premium_LRS" + } + } + } + }, + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/dindurkhya-e2etesting/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with Disk and OS configurations for Single Server System (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilitySet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilitySet.json new file mode 100644 index 000000000000..1ace22d66093 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilitySet.json @@ -0,0 +1,349 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 5, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 5, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 5, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for HA System with Availability Set" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilityZone.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilityZone.json new file mode 100644 index 000000000000..6a88cad4b1bc --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraHaAvailabilityZone.json @@ -0,0 +1,349 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for HA System with Availability Zone" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json new file mode 100644 index 000000000000..a935024adffd --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsComputeGalleryImage.json @@ -0,0 +1,322 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with Azure Compute Gallery Image" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json new file mode 100644 index 000000000000..63344cdac2c8 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesDS.json @@ -0,0 +1,595 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "ascsdisk0" + ] + }, + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + } + ] + }, + "databaseServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "dbhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbnic" + } + ], + "osDiskName": "dbosdisk", + "vmName": "dbvm" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "ascsdisk0" + ] + }, + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + } + ] + }, + "databaseServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "dbhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbnic" + } + ], + "osDiskName": "dbosdisk", + "vmName": "dbvm" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "ascsdisk0" + ] + }, + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + } + ] + }, + "databaseServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "dbhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbnic" + } + ], + "osDiskName": "dbosdisk", + "vmName": "dbvm" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for Distributed System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json new file mode 100644 index 000000000000..62f953099f46 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilitySet.json @@ -0,0 +1,787 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "availabilitySetName": "csAvSet", + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "availabilitySetName": "dbAvSet", + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "availabilitySetName": "csAvSet", + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "availabilitySetName": "dbAvSet", + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "availabilitySetName": "appAvSet", + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "availabilitySetName": "csAvSet", + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "availabilitySetName": "dbAvSet", + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for HA System with Availability Set" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json new file mode 100644 index 000000000000..24a4e153d02c --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesHaAvailabilityZone.json @@ -0,0 +1,778 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "customResourceNames": { + "applicationServer": { + "virtualMachines": [ + { + "dataDiskNames": { + "default": [ + "app0disk0" + ] + }, + "hostName": "apphostName0", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic0" + } + ], + "osDiskName": "app0osdisk", + "vmName": "appvm0" + }, + { + "dataDiskNames": { + "default": [ + "app1disk0" + ] + }, + "hostName": "apphostName1", + "networkInterfaces": [ + { + "networkInterfaceName": "appnic1" + } + ], + "osDiskName": "app1osdisk", + "vmName": "appvm1" + } + ] + }, + "centralServer": { + "loadBalancer": { + "backendPoolNames": [ + "ascsBackendPool" + ], + "frontendIpConfigurationNames": [ + "ascsip0", + "ersip0" + ], + "healthProbeNames": [ + "ascsHealthProbe", + "ersHealthProbe" + ], + "loadBalancerName": "ascslb" + }, + "virtualMachines": [ + { + "hostName": "ascshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ascsnic" + } + ], + "osDiskName": "ascsosdisk", + "vmName": "ascsvm" + }, + { + "hostName": "ershostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ersnic" + } + ], + "osDiskName": "ersosdisk", + "vmName": "ersvm" + } + ] + }, + "databaseServer": { + "loadBalancer": { + "backendPoolNames": [ + "dbBackendPool" + ], + "frontendIpConfigurationNames": [ + "dbip" + ], + "healthProbeNames": [ + "dbHealthProbe" + ], + "loadBalancerName": "dblb" + }, + "virtualMachines": [ + { + "dataDiskNames": { + "hanaData": [ + "hanadatapr0", + "hanadatapr1" + ], + "hanaLog": [ + "hanalogpr0", + "hanalogpr1", + "hanalogpr2" + ], + "hanaShared": [ + "hanasharedpr0", + "hanasharedpr1" + ], + "usrSap": [ + "usrsappr0" + ] + }, + "hostName": "dbprhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbprnic" + } + ], + "osDiskName": "dbprosdisk", + "vmName": "dbvmpr" + }, + { + "dataDiskNames": { + "hanaData": [ + "hanadatasr0", + "hanadatasr1" + ], + "hanaLog": [ + "hanalogsr0", + "hanalogsr1", + "hanalogsr2" + ], + "hanaShared": [ + "hanasharedsr0", + "hanasharedsr1" + ], + "usrSap": [ + "usrsapsr0" + ] + }, + "hostName": "dbsrhostName", + "networkInterfaces": [ + { + "networkInterfaceName": "dbsrnic" + } + ], + "osDiskName": "dbsrosdisk", + "vmName": "dbvmsr" + } + ] + }, + "namingPatternType": "FullResourceName", + "sharedStorage": { + "sharedStorageAccountName": "storageacc", + "sharedStorageAccountPrivateEndPointName": "peForxNFS" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for HA system with Availability Zone" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json new file mode 100644 index 000000000000..be5450a3c29a --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsCustomResourceNamesSingleServer.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "customResourceNames": { + "namingPatternType": "FullResourceName", + "virtualMachine": { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "sshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ssnic" + } + ], + "osDiskName": "ssosdisk", + "vmName": "ssvm" + } + }, + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "customResourceNames": { + "namingPatternType": "FullResourceName", + "virtualMachine": { + "dataDiskNames": { + "hanaData": [ + "hanadata0", + "hanadata1" + ], + "hanaLog": [ + "hanalog0", + "hanalog1", + "hanalog2" + ], + "hanaShared": [ + "hanashared0", + "hanashared1" + ], + "usrSap": [ + "usrsap0" + ] + }, + "hostName": "sshostName", + "networkInterfaces": [ + { + "networkInterfaceName": "ssnic" + } + ], + "osDiskName": "ssosdisk", + "vmName": "ssvm" + } + }, + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with custom resource names for Single Server System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsDSRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsDSRecommended.json new file mode 100644 index 000000000000..e2fa771bb6a1 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsDSRecommended.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for Distributed System (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json new file mode 100644 index 000000000000..7b1fea25a9c7 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilitySetRecommended.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilitySet" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for HA System with Availability Set (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json new file mode 100644 index 000000000000..388c4e6ac966 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsHaAvailabilityZoneRecommended.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "highAvailabilityConfig": { + "highAvailabilityType": "AvailabilityZone" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for HA System with Availability Zone (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json new file mode 100644 index 000000000000..0feb3c816304 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraOsSIngleServerRecommended.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with OS configuration for Single Server System (Recommended)" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraSingleServer.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraSingleServer.json new file mode 100644 index 000000000000..b9a00965e79a --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraSingleServer.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "networkConfiguration": { + "isSecondaryIpEnabled": true + }, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "databaseType": "HANA", + "deploymentType": "SingleServer", + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + } + }, + "environment": "NonProd", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure only for Single Server System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithExistingFileshare.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithExistingFileshare.json new file mode 100644 index 000000000000..e5a4df97ac3b --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithExistingFileshare.json @@ -0,0 +1,337 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Mount", + "id": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint", + "privateEndpointId": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Mount", + "id": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint", + "privateEndpointId": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Mount", + "id": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint", + "privateEndpointId": "/subscriptions/49d64d54-e888-4c46-a868-1936802b762c/resourceGroups/testrg/providers/Microsoft.Network/privateEndpoints/endpoint" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with an existing SAP Transport Directory Fileshare" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithNewFileshare.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithNewFileshare.json new file mode 100644 index 000000000000..f852f967dfa3 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithNewFileshare.json @@ -0,0 +1,337 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "CreateAndMount", + "resourceGroup": "rgName", + "storageAccountName": "storageName" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "CreateAndMount", + "resourceGroup": "rgName", + "storageAccountName": "storageName" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "CreateAndMount", + "resourceGroup": "rgName", + "storageAccountName": "storageName" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure with a new SAP Transport Directory Fileshare" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json new file mode 100644 index 000000000000..4cf2197240eb --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithOsTrustedAccess.json @@ -0,0 +1,319 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "managedResourcesNetworkAccessType": "Private", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier" + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure (with OS configuration) with trusted access enabled" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithoutFileshare.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithoutFileshare.json new file mode 100644 index 000000000000..72c3952d125e --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInfraWithoutFileshare.json @@ -0,0 +1,331 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "xyz", + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Skip" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Skip" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationPending", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 6, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/appsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_E16ds_v4" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/dbsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "storageConfiguration": { + "transportFileShareConfiguration": { + "configurationType": "Skip" + } + } + }, + "osSapConfiguration": { + "sapFqdn": "xyz.test.com" + } + }, + "environment": "Prod", + "health": "Unknown", + "provisioningState": "Updating", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentInProgress", + "status": "Unknown" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Create Infrastructure without a SAP Transport Directory Fileshare" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallDS.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallDS.json new file mode 100644 index 000000000000..0f581f2b6cb4 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallDS.json @@ -0,0 +1,342 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "{{resourcegrp}}", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "8.2", + "version": "8.2.2021091201" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "8.2", + "version": "8.2.2021091201" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "8.2", + "version": "8.2.2021091201" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "sapProduct": "S4HANA" + }, + "tags": { + "created by": "azureuser" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + }, + "201": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Install SAP Software on Distributed System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallSingleServer.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallSingleServer.json new file mode 100644 index 000000000000..3e913f151d06 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateInstallSingleServer.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "test-rg", + "deploymentType": "SingleServer", + "subnetId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/testsubnet", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "SLES-SAP", + "publisher": "SUSE", + "sku": "12-sp4-gen2", + "version": "2022.02.01" + }, + "osProfile": { + "adminUsername": "azureappadmin", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "privateKey": "{{privateKey}}", + "publicKey": "{{sshkey}}" + } + } + }, + "vmSize": "Standard_E32ds_v4" + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": {} + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + }, + "201": { + "body": { + "name": "X00", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/aa-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "eastus2", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "DeploymentWithOSConfig", + "infrastructureConfiguration": { + "appResourceGroup": "aa-rg", + "applicationServer": { + "instanceCount": 2, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_E4ds_v4" + } + }, + "databaseServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/app", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP-HA", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "azureuser", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "ssh-rsa AAA generated-by-azure" + } + } + }, + "vmSize": "Standard_M32ts" + } + }, + "deploymentType": "ThreeTier", + "networkConfiguration": { + "isSecondaryIpEnabled": true + } + }, + "osSapConfiguration": { + "sapFqdn": "sap.bpaas.com" + }, + "softwareConfiguration": { + "bomUrl": "https://teststorageaccount.blob.core.windows.net/sapbits/sapfiles/boms/S41909SPS03_v0011ms/S41909SPS03_v0011ms.yaml", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorageaccount", + "softwareInstallationType": "SAPInstallWithoutOSConfig", + "softwareVersion": "SAP S/4HANA 1909 SPS 03" + } + }, + "environment": "Prod", + "provisioningState": "Accepted", + "sapProduct": "S4HANA", + "state": "SoftwareInstallationInProgress" + }, + "systemData": { + "createdAt": "2022-08-18T18:25:55.2406546Z", + "createdBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "createdByType": "Application", + "lastModifiedAt": "2022-08-18T18:50:59.1945444Z", + "lastModifiedBy": "f1bc9460-9d57-4c16-99a8-5a19378a3a93", + "lastModifiedByType": "Application" + }, + "tags": { + "created by": "azureuser" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Install SAP Software on Single Server System" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutions.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutions.json new file mode 100644 index 000000000000..830b22a20690 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutions.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": { + "createdby": "abc@microsoft.com", + "test": "abc" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Register existing SAP system as Virtual Instance for SAP solutions." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json new file mode 100644 index 000000000000..89216ee342fd --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterSapSolutionsCustom.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "configurationType": "Discovery", + "managedRgStorageAccountName": "q20saacssgrs" + }, + "environment": "NonProd", + "sapProduct": "S4HANA" + }, + "tags": { + "createdby": "abc@microsoft.com", + "test": "abc" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery", + "managedRgStorageAccountName": "q20saacssgrs" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery", + "managedRgStorageAccountName": "q20saacssgrs" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Register existing SAP system as Virtual Instance for SAP solutions with optional customizations." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterWithTrustedAccess.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterWithTrustedAccess.json new file mode 100644 index 000000000000..a30b79a171fe --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_CreateRegisterWithTrustedAccess.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resource": { + "location": "northeurope", + "properties": { + "configuration": { + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/sapq20scsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "managedResourcesNetworkAccessType": "Private", + "sapProduct": "S4HANA" + }, + "tags": { + "createdby": "abc@microsoft.com", + "test": "abc" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Q20", + "type": "microsoft.workloads/sapvirtualinstances", + "id": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/Q20", + "location": "northeurope", + "properties": { + "configuration": { + "appLocation": "westeurope", + "centralServerVmId": "/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg-infra/providers/Microsoft.Compute/virtualMachines/q20ascsvm0", + "configurationType": "Discovery" + }, + "environment": "NonProd", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-Q20-5b0097" + }, + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2022-07-27T08:22:52.3318907Z", + "createdBy": "abc@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-27T11:44:17.9310503Z", + "lastModifiedBy": "abc@microsoft.com", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "SapVirtualInstances_Create", + "title": "Register with trusted access enabled" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Delete.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Delete.json new file mode 100644 index 000000000000..c175b7aa8943 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2024-09-01" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2024-09-01" + } + } + }, + "operationId": "SapVirtualInstances_Delete", + "title": "SAPVirtualInstances_Delete" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Get.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Get.json new file mode 100644 index 000000000000..3ce8b6fd611b --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Get.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Get", + "title": "SAPVirtualInstances_Get" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAcssInstallationBlocked.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAcssInstallationBlocked.json new file mode 100644 index 000000000000..b00f314b5cfc --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAcssInstallationBlocked.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/test-rg/providers/Microsoft.Compute/galleries/testgallery/images/rhelimagetest/versions/0.0.1" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa public key" + } + ] + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "ACSSInstallationBlocked", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "SapVirtualInstances_Get", + "title": "SAPVirtualInstances Get With ACSS Installation Blocked" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json new file mode 100644 index 000000000000..74cea9033f66 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_eastus.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "eastus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "databaseType": "HANA" + } + }, + "responses": { + "200": { + "body": { + "availabilityZonePairs": [ + { + "zoneA": 1, + "zoneB": 2 + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetAvailabilityZoneDetails", + "title": "SAP Availability zone details in east us" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json new file mode 100644 index 000000000000..80a4687a70cb --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetAvailabilityZoneDetails_northeurope.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "northeurope", + "api-version": "2024-09-01", + "body": { + "appLocation": "northeurope", + "sapProduct": "S4HANA", + "databaseType": "HANA" + } + }, + "responses": { + "200": { + "body": { + "availabilityZonePairs": [ + { + "zoneA": 2, + "zoneB": 3 + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetAvailabilityZoneDetails", + "title": "SAP Availability zone details in north europe" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_NonProd.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_NonProd.json new file mode 100644 index 000000000000..f46c7b7b19d3 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_NonProd.json @@ -0,0 +1,399 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "NonProd", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "dbVmSku": "Standard_M32ts" + } + }, + "responses": { + "200": { + "body": { + "volumeConfigurations": { + "hana/data": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 4, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 4, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/log": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 3, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 3, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/shared": { + "recommendedConfiguration": { + "sku": { + "name": "StandardSSD_LRS" + }, + "count": 1, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 1024, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 5000, + "mbpsReadWrite": 200, + "diskTier": "P30" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 2048, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P40" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 4096, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P50" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E15" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E20" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 1024, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E30" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 2048, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E40" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 4096, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E50" + } + ] + }, + "usr/sap": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E15" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E20" + } + ] + }, + "os": { + "recommendedConfiguration": { + "sku": { + "name": "StandardSSD_LRS" + }, + "count": 1, + "sizeGB": 64 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 64, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 240, + "mbpsReadWrite": 50, + "diskTier": "P6" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 64, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "P6" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "P10" + } + ] + }, + "backup": { + "recommendedConfiguration": { + "sku": { + "name": "StandardSSD_LRS" + }, + "count": 2, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E10" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E15" + }, + { + "sku": { + "name": "StandardSSD_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 60, + "diskTier": "E20" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + } + ] + } + } + } + } + }, + "operationId": "SapVirtualInstances_GetDiskConfigurations", + "title": "SAP disk configurations for input environment NonProd." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_Prod.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_Prod.json new file mode 100644 index 000000000000..ddedd6c7439a --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetDiskConfigurations_Prod.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "dbVmSku": "Standard_M32ts" + } + }, + "responses": { + "200": { + "body": { + "volumeConfigurations": { + "hana/data": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 4, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 4, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/log": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 3, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 3, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "hana/shared": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 1024, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 5000, + "mbpsReadWrite": 200, + "diskTier": "P30" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 2048, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P40" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 4096, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 7500, + "mbpsReadWrite": 250, + "diskTier": "P50" + } + ] + }, + "usr/sap": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P10" + } + ] + }, + "os": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 1, + "sizeGB": 64 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 64, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 240, + "mbpsReadWrite": 50, + "diskTier": "P6" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 1, + "maximumSupportedDiskCount": 1, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }, + "backup": { + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 2, + "sizeGB": 256 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 256, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 1100, + "mbpsReadWrite": 125, + "diskTier": "P15" + }, + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 512, + "minimumSupportedDiskCount": 0, + "maximumSupportedDiskCount": 6, + "iopsReadWrite": 2300, + "mbpsReadWrite": 150, + "diskTier": "P20" + } + ] + } + } + } + } + }, + "operationId": "SapVirtualInstances_GetDiskConfigurations", + "title": "SAP disk configurations for input environment Prod." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_Distributed.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_Distributed.json new file mode 100644 index 000000000000..2fb1797f38e3 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_Distributed.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E4ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E8ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E16ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E20ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208s_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416s_v2" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported SKUs for distributed Non HA environment." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json new file mode 100644 index 000000000000..2b3e3084b9bc --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvSet.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "highAvailabilityType": "AvailabilitySet" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E4ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E8ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E16ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E20ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64Is" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M64s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128ms" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M128s" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M208s_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416ms_v2" + }, + { + "isAppServerCertified": false, + "isDatabaseCertified": true, + "vmSku": "Standard_M416s_v2" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported SKUs for distributed HA environment with Availability set." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json new file mode 100644 index 000000000000..a93c6a800cb8 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_DistributedHA_AvZone.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "Prod", + "databaseType": "HANA", + "deploymentType": "ThreeTier", + "highAvailabilityType": "AvailabilityZone" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M32Is" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M64Is" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M64ms" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M64s" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M128ms" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M128s" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M208ms_v2" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M208s_v2" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M416ms_v2" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M416s_v2" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported Skus for HA with availability zone." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_SingleServer.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_SingleServer.json new file mode 100644 index 000000000000..e2f229190732 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSapSupportedSku_SingleServer.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "sapProduct": "S4HANA", + "environment": "NonProd", + "databaseType": "HANA", + "deploymentType": "SingleServer" + } + }, + "responses": { + "200": { + "body": { + "supportedSkus": [ + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E32ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E48ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": false, + "vmSku": "Standard_E64ds_v4" + }, + { + "isAppServerCertified": true, + "isDatabaseCertified": true, + "vmSku": "Standard_M32ts" + } + ] + } + } + }, + "operationId": "SapVirtualInstances_GetSapSupportedSku", + "title": "SAP supported SKUs for single server." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json new file mode 100644 index 000000000000..8b1904344d0c --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_Distributed.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "Prod", + "sapProduct": "S4HANA", + "deploymentType": "ThreeTier", + "saps": 20000, + "dbMemory": 1024, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp" + } + }, + "responses": { + "200": { + "body": { + "deploymentType": "ThreeTier", + "applicationServerVmSku": "Standard_E8ds_v4", + "applicationServerInstanceCount": 2, + "centralServerVmSku": "Standard_E4ds_v4", + "centralServerInstanceCount": 1, + "dbVmSku": "Standard_M64s", + "databaseInstanceCount": 1 + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for non HA distributed system." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json new file mode 100644 index 000000000000..2bbf4abd5ba4 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvSet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "Prod", + "sapProduct": "S4HANA", + "deploymentType": "ThreeTier", + "saps": 75000, + "dbMemory": 1024, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp", + "highAvailabilityType": "AvailabilitySet" + } + }, + "responses": { + "200": { + "body": { + "deploymentType": "ThreeTier", + "applicationServerVmSku": "Standard_E16ds_v4", + "applicationServerInstanceCount": 3, + "centralServerVmSku": "Standard_E8ds_v4", + "centralServerInstanceCount": 2, + "dbVmSku": "Standard_M64s", + "databaseInstanceCount": 2 + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for HA with availability set." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json new file mode 100644 index 000000000000..c0c92f394636 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_HA_AvZone.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "Prod", + "sapProduct": "S4HANA", + "deploymentType": "ThreeTier", + "saps": 75000, + "dbMemory": 1024, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp", + "highAvailabilityType": "AvailabilityZone" + } + }, + "responses": { + "200": { + "body": { + "deploymentType": "ThreeTier", + "applicationServerVmSku": "Standard_E8ds_v4", + "applicationServerInstanceCount": 6, + "centralServerVmSku": "Standard_E4ds_v4", + "centralServerInstanceCount": 2, + "dbVmSku": "Standard_M64s", + "databaseInstanceCount": 2 + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for HA with availability zone." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json new file mode 100644 index 000000000000..d55925c9a9e9 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_GetSizingRecommendations_S4HANA_SingleServer.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "location": "centralus", + "api-version": "2024-09-01", + "body": { + "appLocation": "eastus", + "environment": "NonProd", + "sapProduct": "S4HANA", + "deploymentType": "SingleServer", + "saps": 60000, + "dbMemory": 2000, + "databaseType": "HANA", + "dbScaleMethod": "ScaleUp" + } + }, + "responses": { + "200": { + "body": { + "vmSku": "Standard_M128s", + "deploymentType": "SingleServer" + } + } + }, + "operationId": "SapVirtualInstances_GetSizingRecommendations", + "title": "SAP sizing recommendations for single server." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListByResourceGroup.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..03ba0304fb72 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListByResourceGroup.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "X01", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X01", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapVirtualInstances_ListByResourceGroup", + "title": "SAPVirtualInstances_ListByResourceGroup" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListBySubscription.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListBySubscription.json new file mode 100644 index 000000000000..1a5309669175 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_ListBySubscription.json @@ -0,0 +1,235 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "X01", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X01", + "location": "westcentralus", + "properties": { + "configuration": { + "appLocation": "eastus", + "configurationType": "Deployment", + "infrastructureConfiguration": { + "appResourceGroup": "X00-RG", + "applicationServer": { + "instanceCount": 10, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId3", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "centralServer": { + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId1", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "databaseServer": { + "databaseType": "HANA", + "instanceCount": 1, + "subnetId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Networks/virtualNetworks/vnet1/subnets/subnetId2", + "virtualMachineConfiguration": { + "imageReference": { + "offer": "RHEL-SAP", + "publisher": "RedHat", + "sku": "84sapha-gen2", + "version": "latest" + }, + "osProfile": { + "adminUsername": "{your-username}", + "osConfiguration": { + "disablePasswordAuthentication": true, + "osType": "Linux", + "sshKeyPair": { + "publicKey": "abc" + } + } + }, + "vmSize": "Standard_D8s_v3" + } + }, + "deploymentType": "ThreeTier" + }, + "softwareConfiguration": { + "bomUrl": "https://myaccount.blob.core.windows.net/mycontainer/myblob", + "sapBitsStorageAccountId": "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/ajgupt-test/providers/Microsoft.Storage/storageAccounts/ajguptsavnet", + "sapFqdn": "sapsystem.contoso.net", + "softwareInstallationType": "ServiceInitiated", + "softwareVersion": "SAP S/4HANA 2020 FPS01" + } + }, + "environment": "Prod", + "health": "Healthy", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "RegistrationComplete", + "status": "Running" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "SapVirtualInstances_ListBySubscription", + "title": "SAPVirtualInstances_ListBySubscription" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStop.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStop.json new file mode 100644 index 000000000000..099319582397 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStop.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "Soft Stop of SapVirtualInstances_Stop" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStopVMAndSystem.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStopVMAndSystem.json new file mode 100644 index 000000000000..4da11118564f --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_SoftStopVMAndSystem.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 300 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "Soft Stop the virtual machine(s) and the SAP system on it." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Start.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Start.json new file mode 100644 index 000000000000..82eb7f1824e4 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Start.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0", + "body": { + "startVm": true + } + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Start", + "title": "SAPVirtualInstances_Start" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StartWithInfraOperations.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StartWithInfraOperations.json new file mode 100644 index 000000000000..f5a6ccadbea7 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StartWithInfraOperations.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "startVm": true + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Start", + "title": "SAPVirtualInstances_Start_WithInfraOperations" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Stop.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Stop.json new file mode 100644 index 000000000000..9a5cbdfc41f6 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Stop.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "SAPVirtualInstances_Stop" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StopVMAndSystem.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StopVMAndSystem.json new file mode 100644 index 000000000000..6aacadb61cba --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_StopVMAndSystem.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "body": { + "deallocateVm": true, + "softStopTimeoutSeconds": 0 + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "1e4193c3-206e-4916-b124-1da16175eb0e", + "endTime": "2021-08-19T03:38:07.000Z", + "error": null, + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/operations/locations/centralus/1e4193c3-206e-4916-b124-1da16175eb0e", + "startTime": "2021-08-19T03:36:07.000Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Stop", + "title": "Stop the virtual machine(s) and the SAP system on it." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Update.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Update.json new file mode 100644 index 000000000000..dd1845462b78 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "identity": { + "type": "None" + }, + "properties": {}, + "tags": { + "key1": "svi1" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "identity": { + "type": "None" + }, + "location": "westcentralus", + "properties": { + "configuration": { + "configurationType": "Deployment" + }, + "environment": "Prod", + "health": "Unknown", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentPending", + "status": "Starting" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "svi1" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Update", + "title": "SAPVirtualInstances_Update" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_UpdateTrustedAccess.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_UpdateTrustedAccess.json new file mode 100644 index 000000000000..bad979d054ef --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/stable/2024-09-01/examples/SapVirtualInstances_UpdateTrustedAccess.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "properties": { + "identity": { + "type": "None" + }, + "properties": { + "managedResourcesNetworkAccessType": "Private" + }, + "tags": { + "key1": "svi1" + } + }, + "resourceGroupName": "test-rg", + "sapVirtualInstanceName": "X00", + "subscriptionId": "8e17e36c-42e9-4cd5-a078-7b44883414e0" + }, + "responses": { + "200": { + "body": { + "name": "X00", + "type": "Microsoft.Workloads/sapVirtualInstances", + "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00", + "identity": { + "type": "None" + }, + "location": "westcentralus", + "properties": { + "configuration": { + "configurationType": "Deployment" + }, + "environment": "Prod", + "health": "Unknown", + "managedResourceGroupConfiguration": { + "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443" + }, + "managedResourcesNetworkAccessType": "Private", + "provisioningState": "Succeeded", + "sapProduct": "S4HANA", + "state": "InfrastructureDeploymentPending", + "status": "Starting" + }, + "systemData": { + "createdAt": "2021-08-19T15:10:46.196Z", + "createdBy": "user@xyz.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T15:10:46.196Z", + "lastModifiedBy": "user@xyz.com", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "svi1" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/EASTUS2EUAP/operationStatuses/b7d35156-cfc9-419f-838a-b1e7eff64474*465BB862DF6F3B58F4A29B409D4197F48D5A22B67E126174D4C11F42B19263E5?api-version=2021-12-01-preview" + } + } + }, + "operationId": "SapVirtualInstances_Update", + "title": "SAPVirtualInstances_TrustedAccessEnable_Update" +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/examples/Operations_List.json b/specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..8bf8d1285ed6 --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/examples/Operations_List.json @@ -0,0 +1,1105 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Workloads/RegisteredSubscriptions/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "RegisteredSubscriptions", + "operation": "Gets/Lists registered subscriptions", + "description": "Reads registered subscriptions" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_List", + "description": "Lists WordpressInstances resources under a phpWorkload resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_Get", + "description": "Gets a WordpressInstances resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_CreateOrUpdate", + "description": "Create or updated WordpressInstances resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/wordpressInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads/wordpressInstances", + "operation": "WordpressInstances_Delete", + "description": "Delete WordpressInstances resource" + } + }, + { + "name": "Microsoft.Workloads/skus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Skus", + "operation": "Gets the list of Microsoft.Workloads SKUs available for your Subscription", + "description": "Gets the list of Microsoft.Workloads SKUs available for your Subscription" + } + }, + { + "name": "Microsoft.Workloads/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + }, + { + "name": "Microsoft.Workloads/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Microsoft.Workloads", + "operation": "Register the Microsoft.Workloads", + "description": "Register the subscription for Microsoft.Workloads" + } + }, + { + "name": "Microsoft.Workloads/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Microsoft.Workloads", + "operation": "Unregister the Microsoft.Workloads", + "description": "Unregister the subscription for Microsoft.Workloads" + } + }, + { + "name": "Microsoft.Workloads/Locations/OperationStatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Locations/OperationStatuses", + "operation": "read_OperationStatuses", + "description": "read OperationStatuses" + } + }, + { + "name": "Microsoft.Workloads/Locations/OperationStatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "Locations/OperationStatuses", + "operation": "write_OperationStatuses", + "description": "write OperationStatuses" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_ListBySubscription", + "description": "Lists phpWorkload resources in a subscription" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_ListByResourceGroup", + "description": "Lists phpWorkload resources in a resource group" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_Get", + "description": "Gets a phpWorkload resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_CreateOrUpdate", + "description": "Create or updated phpWorkloads resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_Delete", + "description": "Delete phpWorkloads resource" + } + }, + { + "name": "Microsoft.Workloads/phpWorkloads/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "phpWorkloads", + "operation": "PhpWorkloads_Update", + "description": "Update PHP workload resource." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Get", + "description": "Gets the SAP Application Server Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Create", + "description": "Puts the SAP Application Server Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Delete", + "description": "Deletes the SAP Application Server Instance.

This operation will be used by service only. Delete by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_Update", + "description": "Puts the SAP Application Server Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_List", + "description": "Lists the SAP Application server Instances in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_StartInstance", + "description": "Starts the SAP Application server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/applicationInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/applicationInstances", + "operation": "SAPApplicationServerInstances_StopInstance", + "description": "Stops the SAP Application server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Get", + "description": "Gets the SAP Central Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Create", + "description": "Puts the SAP Central Instance.

This will be used by service only. PUT by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Delete", + "description": "Deletes the SAP Central Instance.

This will be used by service only. Delete by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_Update", + "description": "Updates the SAP Central Instance.

This can be used to update tags." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_List", + "description": "Lists the SAP Central Instances in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_StartInstance", + "description": "Starts the SAP Central server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/centralInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/centralInstances", + "operation": "SAPCentralInstances_StopInstance", + "description": "Stops the SAP Central server Instance in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Get", + "description": "Gets the SAP Database Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Create", + "description": "Puts the SAP Database Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Delete", + "description": "Deletes the SAP Database Instance.

This will be used by service only. Delete by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_Update", + "description": "Puts the SAP Database Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_List", + "description": "Lists the SAP Database Instances in an SVI." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_StartInstance", + "description": "Starts the database instance of the SAP system." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/databaseInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances/databaseInstances", + "operation": "SAPDatabaseInstances_StopInstance", + "description": "Stops the database instance of the SAP system." + } + }, + { + "name": "Microsoft.Workloads/monitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_List", + "description": "Gets a list of SAP monitors in the specified subscription. The operations returns various properties of each SAP monitor." + } + }, + { + "name": "Microsoft.Workloads/monitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_ListByResourceGroup", + "description": "Gets a list of SAP monitors in the specified resource group." + } + }, + { + "name": "Microsoft.Workloads/monitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Get", + "description": "Gets properties of a SAP monitor for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Create", + "description": "Creates a SAP monitor for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Delete", + "description": "Deletes a SAP monitor with the specified subscription, resource group, and monitor name." + } + }, + { + "name": "Microsoft.Workloads/monitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors", + "operation": "monitors_Update", + "description": "Patches the Tags field of a SAP monitor for the specified subscription, resource group, and monitor name." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_List", + "description": "Gets a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_Get", + "description": "Gets properties of a provider instance for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_Create", + "description": "Creates a provider instance for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/providerInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/providerInstances", + "operation": "ProviderInstances_Delete", + "description": "Deletes a provider instance for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_List", + "description": "Gets a list of alert instances in the specified SAP monitor. The operations returns various properties of each provider instances." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_Get", + "description": "Gets properties of a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_Create", + "description": "Creates a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alerts/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alerts", + "operation": "Alerts_Delete", + "description": "Deletes a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alertTemplates/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alertTemplates", + "operation": "AlertTemplates_List", + "description": "Gets properties of an alert template for the specified subscription, resource group, SAP monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/alertTemplates/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/alertTemplates", + "operation": "AlertTemplates_Get", + "description": "Gets properties of a alert for the specified subscription, resource group, Monitor name, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_List", + "description": "Gets a list of properties of a SAP Landscape monitor configuration for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_Get", + "description": "Gets properties of a SAP Landscape monitor configuration for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_Create", + "description": "Creates a SAP Landscape monitor configuration for the specified subscription, resource group, and resource name." + } + }, + { + "name": "Microsoft.Workloads/monitors/sapLandscapeMonitor/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "monitors/sapLandscapeMonitor", + "operation": "SapLandscapeMonitor_Delete", + "description": "Deletes a SAP Landscape monitor configuration with the specified subscription, resource group, and monitor name." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Get", + "description": "Gets an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Create", + "description": "Creates an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Delete", + "description": "Deletes an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Update", + "description": "Updates an SAP Virtual Instance." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_ListByResourceGroup", + "description": "Gets all SAP Virtual Instances in a resource group." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_ListBySubscription", + "description": "Gets all SAP Virtual Instances in the subscription." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/start/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Start", + "description": "Starts the SAP System." + } + }, + { + "name": "Microsoft.Workloads/sapVirtualInstances/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapVirtualInstances", + "operation": "SAPVirtualInstances_Stop", + "description": "Stops the SAP System." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getSizingRecommendations/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPSizingRecommendations", + "description": "Get SAP sizing recommendations." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getSapSupportedSku/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPSupportedSku", + "description": "Get SAP supported SKUs." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getDiskConfigurations/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPDiskConfigurations", + "description": "Get SAP Disk Configurations." + } + }, + { + "name": "Microsoft.Workloads/locations/sapVirtualInstanceMetadata/getAvailabilityZoneDetails/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "locations/sapVirtualInstanceMetadata", + "operation": "SAPAvailabilityZoneDetails", + "description": "Get SAP Availability Zone Details." + } + }, + { + "name": "Microsoft.Workloads/connectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Get", + "description": "Gets a connector resource" + } + }, + { + "name": "Microsoft.Workloads/connectors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Create", + "description": "Creates a connector resource" + } + }, + { + "name": "Microsoft.Workloads/connectors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Delete", + "description": "Deletes a connector resource and its child resources, which are the associated connection resources. All the child resources have to be deleted before deleting the connector resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_Update", + "description": "Updates a connector resource" + } + }, + { + "name": "Microsoft.Workloads/connectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_ListByResourceGroup", + "description": "Gets all connector resources in a Resource Group." + } + }, + { + "name": "Microsoft.Workloads/connectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors", + "operation": "Connectors_ListBySubscription", + "description": "Gets all connector resources in a Subscription." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Get", + "description": "Gets the backup connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Create", + "description": "Creates the backup connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Delete", + "description": "Deletes the backup connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_Update", + "description": "Updates the backup connection resource of virtual instance for SAP.

This can be used to update tags on the resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/acssBackups/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/acssBackups", + "operation": "ACSSBackupConnections_List", + "description": "Lists the backup connection resources of virtual instance for SAP under the given connector resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Get", + "description": "Gets the monitor connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Create", + "description": "Creates the monitor connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Delete", + "description": "Deletes the monitor connection resource of virtual instance for SAP." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_Update", + "description": "Updates the monitor connection resource of virtual instance for SAP.

This can be used to update tags on the resource." + } + }, + { + "name": "Microsoft.Workloads/connectors/sapVirtualInstanceMonitors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "connectors/sapVirtualInstanceMonitors", + "operation": "SapVirtualInstanceMonitorConnections_List", + "description": "Lists the monitor connection resources of virtual instance for SAP under the given connector resource." + } + }, + { + "name": "Microsoft.Workloads/insights/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Get", + "description": "Gets properties of Workloads Insights instance for the specified subscription, resource group and instance name." + } + }, + { + "name": "Microsoft.Workloads/insights/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_ListByResourceGroup", + "description": "Gets a list of Workloads Insight instances in the specified subscription and resource group. The operations returns various properties of each instance." + } + }, + { + "name": "Microsoft.Workloads/insights/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_List", + "description": "Gets a list of Workloads Insight instances in the specified subscription. The operations returns various properties of each instance." + } + }, + { + "name": "Microsoft.Workloads/insights/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Create", + "description": "Creates a Workloads Insights instance for the specified subscription, resource group, and instance name." + } + }, + { + "name": "Microsoft.Workloads/insights/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Delete", + "description": "Deletes a Workloads Insights instance for the specified subscription, resource group and instance name." + } + }, + { + "name": "Microsoft.Workloads/insights/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "insights", + "operation": "Insights_Update", + "description": "Patches the Workload Insights instance for the specified subscription, resource group, and instance name." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Get", + "description": "Gets a SAP Migration discovery site resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Create", + "description": "Creates a discovery site for SAP Migration." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Delete", + "description": "Deletes a SAP Migration discovery site resource and its child resources, that is the associated SAP Instances and Server Instances." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_Update", + "description": "SAPDiscoverySites_Update." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_ListByResourceGroup", + "description": "Gets all SAP Migration discovery site resources in a Resource Group." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_ListBySubscription", + "description": "Gets all SAP Migration discovery site resources in a Subscription." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/importEntities/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites", + "operation": "SAPDiscoverySites_ImportEntities", + "description": "Import a SAP Migration discovery site resource and it's child resources, that is the SAP instances and Server instances." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Get", + "description": "Gets the SAP Instance resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Create", + "description": "Creates the SAP Instance resource.

This will be used by service only. PUT operation on this resource by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Delete", + "description": "Deletes the SAP Instance resource.

This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the SAP Migration discovery site resource, using the delete operation on it." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_Update", + "description": "Updates the SAP Instance resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances", + "operation": "SAPInstances_List", + "description": "Lists the SAP Instance resources for the given SAP Migration discovery site resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Get", + "description": "Gets the Server Instance resource." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Create", + "description": "Creates the Server Instance resource.

This will be used by service only. PUT operation on this resource by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Delete", + "description": "Deletes the Server Instance resource.

This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the SAP Migration discovery site resource, using the delete operation on it." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_Update", + "description": "Updates the Server Instance resource. This operation on a resource by end user will return a Bad Request error." + } + }, + { + "name": "Microsoft.Workloads/sapDiscoverySites/sapInstances/serverInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Workloads", + "resource": "sapDiscoverySites/sapInstances/serverInstances", + "operation": "ServerInstances_List", + "description": "Lists the Server Instance resources for the given SAP Instance resource." + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/operations.json b/specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/operations.json new file mode 100644 index 000000000000..2fc6c740381b --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/operations/stable/2024-09-01/operations.json @@ -0,0 +1,86 @@ +{ + "swagger": "2.0", + "info": { + "title": "Workloads Client", + "version": "2024-09-01", + "description": "Workloads client provides access to various workload operations.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.Workloads/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the operations for the provider.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": {} +} From d460585857947d5f15fe022ac5a8b2b49f6e0761 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Tue, 27 Aug 2024 13:50:05 +0800 Subject: [PATCH 08/30] [recoveryservicessiterecovery] update python config (#30330) * update python config * update python config * Update readme.python.md --- .../resource-manager/readme.python.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.python.md b/specification/recoveryservicessiterecovery/resource-manager/readme.python.md index dd95b21219e1..35bac000ae08 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.python.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.python.md @@ -16,3 +16,31 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/recoveryservices/azure-mgmt-recoveryservicessiterecovery/azure/mgmt/recoveryservicessiterecovery ``` + +``` yaml $(python) +directive: +- from: swagger-document + where: $.parameters.ResourceGroupName + transform: > + $["x-ms-parameter-location"] = "client"; + +- from: swagger-document + where: $.parameters.ResourceName + transform: > + $["x-ms-parameter-location"] = "client"; + +- from: swagger-document + where: $.parameters.FabricName + transform: > + $["x-ms-parameter-location"] = "method"; + +- from: swagger-document + where: $.parameters.ProtectionContainerName + transform: > + $["x-ms-parameter-location"] = "method"; + +- from: swagger-document + where: $.parameters.ReplicationProtectionClusterName + transform: > + $["x-ms-parameter-location"] = "method"; +``` From 2bd041f5ca9945257b581889c01b9e445bd0e8de Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Tue, 27 Aug 2024 15:13:01 +0800 Subject: [PATCH 09/30] =?UTF-8?q?Revert=20"Downgraded=20the=20version=20of?= =?UTF-8?q?=20ManagedInstances=20to=20generate=20.Net=20SDK=20for=20s?= =?UTF-8?q?=E2=80=A6"=20(#30261)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This reverts commit f45a76fc39f033947ed12faf4b6416e1e19724cd. --- specification/sql/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 99630ad97c3d..2e84f8a3645e 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -1415,7 +1415,6 @@ input-file: - ./Microsoft.Sql/preview/2023-02-01-preview/Databases.json - ./Microsoft.Sql/preview/2022-08-01-preview/ElasticPools.json - ./Microsoft.Sql/preview/2022-08-01-preview/ManagedDatabases.json -- ./Microsoft.Sql/preview/2022-08-01-preview/ManagedInstances.json - ./Microsoft.Sql/preview/2022-08-01-preview/ManagedLedgerDigestUploads.json - ./Microsoft.Sql/preview/2022-08-01-preview/RecoverableDatabases.json - ./Microsoft.Sql/preview/2022-08-01-preview/RestorableDroppedDatabases.json @@ -1440,6 +1439,7 @@ input-file: - ./Microsoft.Sql/preview/2023-05-01-preview/InstancePools.json - ./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json - ./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json +- ./Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json - ./Microsoft.Sql/preview/2023-05-01-preview/Servers.json - ./Microsoft.Sql/preview/2023-05-01-preview/ReplicationLinks.json From fa6609332acece21de44c0bf885cbcb3d87bd01f Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Tue, 27 Aug 2024 15:19:32 +0800 Subject: [PATCH 10/30] [mobilepacketcore] update python config (#30335) * update python config * Update readme.python.md --- .../resource-manager/readme.python.md | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/specification/mobilepacketcore/resource-manager/readme.python.md b/specification/mobilepacketcore/resource-manager/readme.python.md index b8236c2369a9..f34e9759a8bb 100644 --- a/specification/mobilepacketcore/resource-manager/readme.python.md +++ b/specification/mobilepacketcore/resource-manager/readme.python.md @@ -3,19 +3,21 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: Microsoft.MobilePacketCore - package-name: mobileCore - package-version: 2023-10-15-preview - clear-output-folder: true +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-mobilepacketcore +namespace: azure.mgmt.mobilepacketcore +package-version: 1.0.0b1 +clear-output-folder: true ``` -```yaml $(python) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt/mobileCore +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/mobilepacketcore/azure-mgmt-mobilepacketcore/azure/mgmt/mobilepacketcore +``` + +``` yaml $(python) +modelerfour: + flatten-models: false ``` From 3af4510ece99b66c19817634b6a43a353228e548 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:55:58 +0800 Subject: [PATCH 11/30] [MpcNetworkFunction] update python config (#30336) * Update readme.python.md * Update readme.python.md --- .../resource-manager/readme.python.md | 1 + .../resource-manager/readme.python.md | 25 +++++++++++-------- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/specification/mobilepacketcore/resource-manager/readme.python.md b/specification/mobilepacketcore/resource-manager/readme.python.md index f34e9759a8bb..09d6b84542de 100644 --- a/specification/mobilepacketcore/resource-manager/readme.python.md +++ b/specification/mobilepacketcore/resource-manager/readme.python.md @@ -4,6 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(python) +title: MobilePacketCoreMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-mobilepacketcore diff --git a/specification/mpcnetworkfunction/resource-manager/readme.python.md b/specification/mpcnetworkfunction/resource-manager/readme.python.md index 85e1a1ae4cc7..d1008891bb2e 100644 --- a/specification/mpcnetworkfunction/resource-manager/readme.python.md +++ b/specification/mpcnetworkfunction/resource-manager/readme.python.md @@ -4,18 +4,21 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: Microsoft.MobilePacketCore - package-name: mobileCore - package-version: 2023-05-15-preview - clear-output-folder: true +title: MpcNetworkFunctionMgmtClient +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-mpcnetworkfunction +namespace: azure.mgmt.mpcnetworkfunction +package-version: 1.0.0b1 +clear-output-folder: true ``` ```yaml $(python) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt/mobileCore +no-namespace-folders: true +output-folder: $(python-sdks-folder)/MpcNetworkFunction/azure-mgmt-mpcnetworkfunction/azure/mgmt/mpcnetworkfunction +``` + +``` yaml $(python) +modelerfour: + flatten-models: false ``` From 3032cb1b8231e0a40765f7fb3228b30f9c514898 Mon Sep 17 00:00:00 2001 From: Bryan Strassner Date: Tue, 27 Aug 2024 09:08:20 -0500 Subject: [PATCH 12/30] Microsoft.NetworkCloud 2024-06-01-preview for public (#29555) * Microsoft.NetworkCloud base version for 2024-06-01-preview * Microsoft.NetworkCloud changes for 2024-06-01-preview API * Add suppressions of required field error in common and shared patch structures * Make KubnernetesClusterFeatures properties optional for CLI * Adjust for lintdiff found in forthcoming 2024-07-01 version * Add exclusion for bug in lintdiff linter * Create sdk-suppressions.yaml --------- Co-authored-by: Marina Bashtovaya Co-authored-by: Yuchao Yan --- .../examples/AgentPools_Create.json | 255 + .../examples/AgentPools_Delete.json | 17 + .../examples/AgentPools_Get.json | 97 + .../AgentPools_ListByKubernetesCluster.json | 101 + .../examples/AgentPools_Patch.json | 208 + .../BareMetalMachineKeySets_Create.json | 174 + .../BareMetalMachineKeySets_Delete.json | 17 + .../examples/BareMetalMachineKeySets_Get.json | 79 + ...BareMetalMachineKeySets_ListByCluster.json | 83 + .../BareMetalMachineKeySets_Patch.json | 170 + .../examples/BareMetalMachines_Cordon.json | 18 + .../examples/BareMetalMachines_Create.json | 225 + .../examples/BareMetalMachines_Delete.json | 16 + .../examples/BareMetalMachines_Get.json | 103 + ...BareMetalMachines_ListByResourceGroup.json | 107 + .../BareMetalMachines_ListBySubscription.json | 106 + .../examples/BareMetalMachines_Patch.json | 209 + .../examples/BareMetalMachines_PowerOff.json | 18 + .../examples/BareMetalMachines_Reimage.json | 15 + .../examples/BareMetalMachines_Replace.json | 25 + .../examples/BareMetalMachines_Restart.json | 15 + .../BareMetalMachines_RunCommand.json | 23 + .../BareMetalMachines_RunDataExtracts.json | 27 + .../BareMetalMachines_RunReadCommands.json | 35 + .../examples/BareMetalMachines_Start.json | 15 + .../examples/BareMetalMachines_Uncordon.json | 15 + .../examples/BmcKeySets_Create.json | 159 + .../examples/BmcKeySets_Delete.json | 17 + .../examples/BmcKeySets_Get.json | 74 + .../examples/BmcKeySets_ListByCluster.json | 78 + .../examples/BmcKeySets_Patch.json | 156 + .../CloudServicesNetworks_Create.json | 152 + .../CloudServicesNetworks_Delete.json | 16 + .../examples/CloudServicesNetworks_Get.json | 67 + ...dServicesNetworks_ListByResourceGroup.json | 71 + ...udServicesNetworks_ListBySubscription.json | 70 + .../examples/CloudServicesNetworks_Patch.json | 148 + .../examples/ClusterManagers_Create.json | 131 + .../examples/ClusterManagers_Create_Uami.json | 142 + .../examples/ClusterManagers_Delete.json | 16 + .../examples/ClusterManagers_Get.json | 60 + .../ClusterManagers_ListByResourceGroup.json | 64 + .../ClusterManagers_ListBySubscription.json | 63 + .../examples/ClusterManagers_Patch.json | 77 + .../ClusterMetricsConfigurations_Create.json | 108 + .../ClusterMetricsConfigurations_Delete.json | 17 + .../ClusterMetricsConfigurations_Get.json | 49 + ...erMetricsConfigurations_ListByCluster.json | 53 + .../ClusterMetricsConfigurations_Patch.json | 104 + .../Clusters_ContinueUpdateVersion.json | 18 + .../examples/Clusters_Create.json | 547 + .../examples/Clusters_Delete.json | 16 + .../examples/Clusters_Deploy.json | 16 + .../Clusters_Deploy_SkipValidation.json | 20 + .../examples/Clusters_Get.json | 203 + .../Clusters_ListByResourceGroup.json | 207 + .../examples/Clusters_ListBySubscription.json | 206 + ...atch_AggregatorOrSingleRackDefinition.json | 456 + .../Clusters_Patch_CommandOutput.json | 428 + .../examples/Clusters_Patch_Location.json | 409 + ..._Patch_RuntimeProtectionConfiguration.json | 411 + .../Clusters_Patch_SecretArchive.json | 412 + .../Clusters_Patch_UpdateStrategy.json | 415 + .../examples/Clusters_ScanRuntime.json | 18 + .../examples/Clusters_UpdateVersion.json | 18 + .../examples/Consoles_Create.json | 104 + .../examples/Consoles_Delete.json | 17 + .../examples/Consoles_Get.json | 47 + .../Consoles_ListByVirtualMachine.json | 51 + .../examples/Consoles_Patch.json | 100 + .../KubernetesClusterFeatures_Create.json | 97 + .../KubernetesClusterFeatures_Delete.json | 17 + .../KubernetesClusterFeatures_Get.json | 45 + ...usterFeatures_ListByKubernetesCluster.json | 48 + .../KubernetesClusterFeatures_Patch.json | 97 + .../examples/KubernetesClusters_Create.json | 716 + .../examples/KubernetesClusters_Delete.json | 16 + .../examples/KubernetesClusters_Get.json | 271 + ...ernetesClusters_L2LoadBalancer_Create.json | 629 + ...ubernetesClusters_ListByResourceGroup.json | 275 + ...KubernetesClusters_ListBySubscription.json | 273 + .../examples/KubernetesClusters_Patch.json | 562 + .../KubernetesClusters_RestartNode.json | 18 + .../examples/L2Networks_Create.json | 99 + .../examples/L2Networks_Delete.json | 16 + .../examples/L2Networks_Get.json | 45 + .../L2Networks_ListByResourceGroup.json | 49 + .../L2Networks_ListBySubscription.json | 48 + .../examples/L2Networks_Patch.json | 51 + .../examples/L3Networks_Create.json | 110 + .../examples/L3Networks_Delete.json | 16 + .../examples/L3Networks_Get.json | 49 + .../L3Networks_ListByResourceGroup.json | 53 + .../L3Networks_ListBySubscription.json | 52 + .../examples/L3Networks_Patch.json | 55 + .../examples/Operations_List.json | 38 + .../examples/RackSkus_Get.json | 107 + .../examples/RackSkus_ListBySubscription.json | 110 + .../examples/Racks_Create.json | 98 + .../examples/Racks_Delete.json | 16 + .../examples/Racks_Get.json | 44 + .../examples/Racks_ListByResourceGroup.json | 48 + .../examples/Racks_ListBySubscription.json | 47 + .../examples/Racks_Patch.json | 92 + .../examples/StorageAppliances_Create.json | 150 + .../examples/StorageAppliances_Delete.json | 16 + ...liances_DisableRemoteVendorManagement.json | 15 + ...pliances_EnableRemoteVendorManagement.json | 20 + .../examples/StorageAppliances_Get.json | 68 + ...StorageAppliances_ListByResourceGroup.json | 72 + .../StorageAppliances_ListBySubscription.json | 71 + .../examples/StorageAppliances_Patch.json | 139 + .../examples/TrunkedNetworks_Create.json | 119 + .../examples/TrunkedNetworks_Delete.json | 16 + .../examples/TrunkedNetworks_Get.json | 52 + .../TrunkedNetworks_ListByResourceGroup.json | 56 + .../TrunkedNetworks_ListBySubscription.json | 55 + .../examples/TrunkedNetworks_Patch.json | 58 + .../examples/VirtualMachines_Create.json | 248 + .../examples/VirtualMachines_Delete.json | 16 + .../examples/VirtualMachines_Get.json | 96 + .../VirtualMachines_ListByResourceGroup.json | 100 + .../VirtualMachines_ListBySubscription.json | 99 + .../examples/VirtualMachines_Patch.json | 199 + .../examples/VirtualMachines_PowerOff.json | 18 + .../examples/VirtualMachines_Reimage.json | 15 + .../examples/VirtualMachines_Restart.json | 15 + .../examples/VirtualMachines_Start.json | 15 + .../examples/Volumes_Create.json | 95 + .../examples/Volumes_Delete.json | 16 + .../examples/Volumes_Get.json | 44 + .../examples/Volumes_ListByResourceGroup.json | 48 + .../examples/Volumes_ListBySubscription.json | 47 + .../examples/Volumes_Patch.json | 50 + .../2024-06-01-preview/networkcloud.json | 13441 ++++++++++++++++ .../networkcloud/resource-manager/readme.md | 27 +- .../resource-manager/sdk-suppressions.yaml | 5 + 137 files changed, 27991 insertions(+), 1 deletion(-) create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_ListByKubernetesCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_ListByCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Cordon.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_PowerOff.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Reimage.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Replace.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Restart.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunCommand.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunDataExtracts.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunReadCommands.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Start.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Uncordon.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_ListByCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create_Uami.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_ListByCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ContinueUpdateVersion.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy_SkipValidation.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_CommandOutput.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_Location.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_RuntimeProtectionConfiguration.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_SecretArchive.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_UpdateStrategy.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ScanRuntime.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_UpdateVersion.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_ListByVirtualMachine.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_L2LoadBalancer_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_RestartNode.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Operations_List.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_PowerOff.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Reimage.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Restart.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Start.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Create.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Delete.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Get.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListByResourceGroup.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListBySubscription.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Patch.json create mode 100644 specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/networkcloud.json create mode 100644 specification/networkcloud/resource-manager/sdk-suppressions.yaml diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Create.json new file mode 100644 index 000000000000..87da4db3da62 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Create.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName", + "agentPoolParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "provisioningState": "Accepted", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Delete.json new file mode 100644 index 000000000000..e369f23ee44b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Get.json new file mode 100644 index 000000000000..28cd209e45c3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Get.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_ListByKubernetesCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_ListByKubernetesCluster.json new file mode 100644 index 000000000000..ab72ee16d8b8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_ListByKubernetesCluster.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Patch.json new file mode 100644 index 000000000000..65d84a0a7d37 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/AgentPools_Patch.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName", + "agentPoolUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "count": 3, + "upgradeSettings": { + "maxSurge": "1", + "maxUnavailable": "0", + "drainTimeout": 1800 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "provisioningState": "Accepted", + "kubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Create.json new file mode 100644 index 000000000000..1ea8874af842 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Create.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName", + "bareMetalMachineKeySetParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Delete.json new file mode 100644 index 000000000000..899f656614c9 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Get.json new file mode 100644 index 000000000000..fe78d72b7631 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_ListByCluster.json new file mode 100644 index 000000000000..0751088e019c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_ListByCluster.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Patch.json new file mode 100644 index 000000000000..928d4a43f60a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachineKeySets_Patch.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName", + "bareMetalMachineKeySetUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "expiration": "2022-12-31T23:59:59.008Z", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted", + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Cordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Cordon.json new file mode 100644 index 000000000000..589ce51d2bff --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Cordon.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineCordonParameters": { + "evacuate": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Create.json new file mode 100644 index 000000000000..6b5c6fd2e65d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Create.json @@ -0,0 +1,225 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser", + "password": "{password}" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Delete.json new file mode 100644 index 000000000000..d3a37aa413b4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Get.json new file mode 100644 index 000000000000..1fa64dbf71a8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Get.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListByResourceGroup.json new file mode 100644 index 000000000000..a863a4929b4a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListByResourceGroup.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListBySubscription.json new file mode 100644 index 000000000000..1ab7c1150e35 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_ListBySubscription.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Patch.json new file mode 100644 index 000000000000..e0bd99a28881 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Patch.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "machineDetails": "machinedetails" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.28.3", + "machineClusterVersion": "3.8.7", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + }, + "secretRotationStatus": [ + { + "secretType": "Bare Metal Machine Identity - console", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_PowerOff.json new file mode 100644 index 000000000000..7b4f280d819e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_PowerOff.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachinePowerOffParameters": { + "skipShutdown": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Reimage.json new file mode 100644 index 000000000000..3aa5e60714a4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Reimage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Replace.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Replace.json new file mode 100644 index 000000000000..91dd89a65ec4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Replace.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineReplaceParameters": { + "bootMacAddress": "00:00:4e:00:58:af", + "bmcCredentials": { + "username": "bmcuser", + "password": "{password}" + }, + "serialNumber": "BM1219XXX", + "bmcMacAddress": "00:00:4f:00:57:ad", + "machineName": "name" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Restart.json new file mode 100644 index 000000000000..3aa5e60714a4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunCommand.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunCommand.json new file mode 100644 index 000000000000..04b9b03f3f33 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunCommand.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunCommandParameters": { + "script": "cHdkCg==", + "arguments": [ + "--argument1", + "argument2" + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunDataExtracts.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunDataExtracts.json new file mode 100644 index 000000000000..addc66a69d80 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunDataExtracts.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunDataExtractsParameters": { + "commands": [ + { + "command": "hardware-support-data-collection", + "arguments": [ + "SysInfo", + "TTYLog" + ] + } + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunReadCommands.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunReadCommands.json new file mode 100644 index 000000000000..4cd3e9f727f2 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_RunReadCommands.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunReadCommandsParameters": { + "commands": [ + { + "command": "kubectl get", + "arguments": [ + "pods", + "-A" + ] + }, + { + "command": "ping", + "arguments": [ + "192.168.0.99", + "-c", + "3" + ] + } + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Start.json new file mode 100644 index 000000000000..3aa5e60714a4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Uncordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Uncordon.json new file mode 100644 index 000000000000..3aa5e60714a4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BareMetalMachines_Uncordon.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Create.json new file mode 100644 index 000000000000..8d3a1246bf4e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Create.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName", + "bmcKeySetParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Delete.json new file mode 100644 index 000000000000..f5b1810d0d16 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Get.json new file mode 100644 index 000000000000..75864728c8d1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_ListByCluster.json new file mode 100644 index 000000000000..5da6045c0252 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_ListByCluster.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Patch.json new file mode 100644 index 000000000000..df50cc3749fe --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/BmcKeySets_Patch.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName", + "bmcKeySetUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "expiration": "2022-12-31T23:59:59.008Z", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Accepted", + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Invalid Azure user(s) were provided: userXYZ" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Create.json new file mode 100644 index 000000000000..7d426852960f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Create.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName", + "cloudServicesNetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Delete.json new file mode 100644 index 000000000000..5043366d593e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Get.json new file mode 100644 index 000000000000..806d6d7661fb --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..3c7be646e7e8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListBySubscription.json new file mode 100644 index 000000000000..a0967b0ed9f0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Patch.json new file mode 100644 index 000000000000..df991fa675f5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/CloudServicesNetworks_Patch.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName", + "cloudServicesNetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Accepted", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create.json new file mode 100644 index 000000000000..eac7d231492b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create_Uami.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create_Uami.json new file mode 100644 index 000000000000..48b0a2b6b007 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Create_Uami.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Delete.json new file mode 100644 index 000000000000..6b90cd2ba669 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Get.json new file mode 100644 index 000000000000..9fafb5a3fd45 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListByResourceGroup.json new file mode 100644 index 000000000000..27b0a0bf575a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListBySubscription.json new file mode 100644 index 000000000000..f0175c660043 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "principalId": "321e7654-e89b-12d3-a456-426655449999", + "tenantId": "199e9999-e89b-12d3-a456-426655441111", + "type": "SystemAssigned" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Patch.json new file mode 100644 index 000000000000..8c0833ae112e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterManagers_Patch.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": null, + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Create.json new file mode 100644 index 000000000000..e896d48875ee --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Create.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default", + "metricsConfigurationParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Accepted", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Delete.json new file mode 100644 index 000000000000..24c7698b226a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Get.json new file mode 100644 index 000000000000..ccc380fbfc1d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_ListByCluster.json new file mode 100644 index 000000000000..75369bb01327 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_ListByCluster.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Patch.json new file mode 100644 index 000000000000..43894694adb5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/ClusterMetricsConfigurations_Patch.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default", + "metricsConfigurationUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Accepted", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ContinueUpdateVersion.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ContinueUpdateVersion.json new file mode 100644 index 000000000000..e0d22e2d5a29 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ContinueUpdateVersion.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterContinueUpdateVersionParameters": { + "machineGroupTargetingMode": "AlphaByRack" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Create.json new file mode 100644 index 000000000000..9ed858073c55 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Create.json @@ -0,0 +1,547 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012", + "password": "{password}" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "PendingDeployment", + "detailedStatusMessage": "Cluster creation is accepted. Deployment is pending.", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Delete.json new file mode 100644 index 000000000000..b15b349cccb6 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy.json new file mode 100644 index 000000000000..b668032b5fc4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterDeployParameters": {} + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy_SkipValidation.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy_SkipValidation.json new file mode 100644 index 000000000000..890a165129c4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Deploy_SkipValidation.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterDeployParameters": { + "skipValidationsForMachines": [ + "bmmName1" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Get.json new file mode 100644 index 000000000000..35f01357439a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Get.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListByResourceGroup.json new file mode 100644 index 000000000000..1933970c09ec --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListByResourceGroup.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListBySubscription.json new file mode 100644 index 000000000000..0f92099d40ba --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ListBySubscription.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json new file mode 100644 index 000000000000..dab01e288295 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json @@ -0,0 +1,456 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_CommandOutput.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_CommandOutput.json new file mode 100644 index 000000000000..99a0243d29cd --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_CommandOutput.json @@ -0,0 +1,428 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": null, + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": {} + } + }, + "properties": { + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2": { + "clientId": "200e0000-e89b-12d3-a456-426655440000", + "principalId": "321e7654-e89b-12d3-a456-426655449999" + } + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity2" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_Location.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_Location.json new file mode 100644 index 000000000000..cce443e50beb --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_Location.json @@ -0,0 +1,409 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "clusterLocation": "Foo Street, 3rd Floor, row 9" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_RuntimeProtectionConfiguration.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_RuntimeProtectionConfiguration.json new file mode 100644 index 000000000000..ef7e9f24206f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_RuntimeProtectionConfiguration.json @@ -0,0 +1,411 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_SecretArchive.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_SecretArchive.json new file mode 100644 index 000000000000..09e34ac7cd1f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_SecretArchive.json @@ -0,0 +1,412 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_UpdateStrategy.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_UpdateStrategy.json new file mode 100644 index 000000000000..473b7d3f89ba --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_Patch_UpdateStrategy.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1": {} + } + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "commandOutputSettings": { + "containerUrl": "https://myaccount.blob.core.windows.net/mycontainer?restype=container", + "associatedIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity1" + } + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ScanRuntime.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ScanRuntime.json new file mode 100644 index 000000000000..d42b18b04a77 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_ScanRuntime.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterScanRuntimeParameters": { + "scanActivity": "Scan" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_UpdateVersion.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_UpdateVersion.json new file mode 100644 index 000000000000..d5a694ec9d24 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Clusters_UpdateVersion.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateVersionParameters": { + "targetClusterVersion": "2.0" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Create.json new file mode 100644 index 000000000000..b9ff47ae2fa9 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default", + "consoleParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Accepted", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Delete.json new file mode 100644 index 000000000000..ddb2948b8ccd --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Get.json new file mode 100644 index 000000000000..0a66d575a796 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_ListByVirtualMachine.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_ListByVirtualMachine.json new file mode 100644 index 000000000000..ab9bae4e7eb3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_ListByVirtualMachine.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Patch.json new file mode 100644 index 000000000000..043a6c98dde5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Consoles_Patch.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default", + "consoleUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "expiration": "2022-06-01T01:27:03.008Z", + "enabled": "True" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Accepted", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Create.json new file mode 100644 index 000000000000..1562e5029fbe --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Create.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName", + "kubernetesClusterFeatureParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Delete.json new file mode 100644 index 000000000000..25299a501702 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Get.json new file mode 100644 index 000000000000..4d6ffd6e4fa4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json new file mode 100644 index 000000000000..475e71965251 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_ListByKubernetesCluster.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Patch.json new file mode 100644 index 000000000000..da5310607bd8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusterFeatures_Patch.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "featureName": "featureName", + "kubernetesClusterFeatureUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/features/featureName", + "name": "featureName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/features", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "options": [ + { + "key": "featureOptionName", + "value": "featureOptionValue" + } + ], + "availabilityLifecycle": "GenerallyAvailable", + "detailedStatus": "Installed", + "detailedStatusMessage": "The feature is successfully installed.", + "required": "True", + "version": "1.2.3", + "provisioningState": "Accepted" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Create.json new file mode 100644 index 000000000000..f222e26059af --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Create.json @@ -0,0 +1,716 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Delete.json new file mode 100644 index 000000000000..3dba9cf88cea --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Get.json new file mode 100644 index 000000000000..92264a8482c7 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Get.json @@ -0,0 +1,271 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_L2LoadBalancer_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_L2LoadBalancer_Create.json new file mode 100644 index 000000000000..22bafdbb7eeb --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_L2LoadBalancer_Create.json @@ -0,0 +1,629 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.2-198.51.102.254" + ], + "autoAssign": "True", + "name": "pool1" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.2-198.51.102.254" + ], + "autoAssign": "True", + "name": "pool1" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.2-198.51.102.254" + ], + "autoAssign": "True", + "name": "pool1" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..08d346ca7243 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListByResourceGroup.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListBySubscription.json new file mode 100644 index 000000000000..636fbb0e6c9c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_ListBySubscription.json @@ -0,0 +1,273 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Patch.json new file mode 100644 index 000000000000..498bdee87433 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_Patch.json @@ -0,0 +1,562 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "count": 3 + }, + "kubernetesVersion": "1.XX.Y" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_XXXX", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_XXXX" + }, + "kubernetesVersion": "1.XX.Y", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.XX.Y", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.XX.Y", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.XX.Y", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_XXXX" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_RestartNode.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_RestartNode.json new file mode 100644 index 000000000000..dcaf0d85c5df --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/KubernetesClusters_RestartNode.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterRestartNodeParameters": { + "nodeName": "nodeName" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Create.json new file mode 100644 index 000000000000..8e4a328e734a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName", + "l2NetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "hybridAksPluginType": "DPDK" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Delete.json new file mode 100644 index 000000000000..4baf6e3030fa --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Get.json new file mode 100644 index 000000000000..e7a9a9309182 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListByResourceGroup.json new file mode 100644 index 000000000000..6089095bb971 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListBySubscription.json new file mode 100644 index 000000000000..4b5b18d912ad --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Patch.json new file mode 100644 index 000000000000..d720338f74e1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L2Networks_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName", + "l2NetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Create.json new file mode 100644 index 000000000000..888be42d92d4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Create.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName", + "l3NetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Delete.json new file mode 100644 index 000000000000..cb962daaa1f2 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Get.json new file mode 100644 index 000000000000..efa8ddb5925b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListByResourceGroup.json new file mode 100644 index 000000000000..4219cf083539 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListBySubscription.json new file mode 100644 index 000000000000..1d952a0d1f02 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Patch.json new file mode 100644 index 000000000000..ac911b446066 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/L3Networks_Patch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName", + "l3NetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Operations_List.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..8268fdd0732a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Operations_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://fully.qualified.hyperlink", + "value": [ + { + "actionType": "Internal", + "display": { + "description": "Reads Network Cloud cluster(s)", + "operation": "Get/list Network Cloud cluster resources", + "provider": "Microsoft Network Cloud", + "resource": "Network Cloud cluster" + }, + "isDataAction": true, + "name": "Microsoft.NetworkCloud/clusters/Read", + "origin": "user,system" + }, + { + "actionType": "Internal", + "display": { + "description": "Writes Network Cloud cluster(s)", + "operation": "Create/update Network Cloud cluster resources", + "provider": "Microsoft Network Cloud", + "resource": "Network Cloud cluster" + }, + "isDataAction": true, + "name": "Microsoft.NetworkCloud/clusters/Write", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_Get.json new file mode 100644 index 000000000000..34dfb6b0a1d5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_Get.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "rackSkuName": "rackSkuName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "name": "rackSkuName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/rackSkus", + "properties": { + "provisioningState": "Succeeded", + "rackType": "Single", + "maxClusterSlots": 0, + "description": "Sample SKU for the single rack.", + "controllerMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R650", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 1, + "cpuCores": 8, + "totalThreads": 16, + "memoryCapacityGB": 128, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 2, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 5 + } + ], + "computeMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R750", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 2, + "cpuCores": 28, + "totalThreads": 112, + "memoryCapacityGB": 512, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 1, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 1 + } + ], + "storageAppliances": [ + { + "properties": { + "capacityGB": 9100, + "model": "x70r3-9" + }, + "rackSlot": 2 + } + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_ListBySubscription.json new file mode 100644 index 000000000000..349d159a38b4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/RackSkus_ListBySubscription.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "name": "rackSkuName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/rackSkus", + "properties": { + "provisioningState": "Succeeded", + "rackType": "Single", + "maxClusterSlots": 0, + "description": "Sample SKU for the single rack.", + "controllerMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R650", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 1, + "cpuCores": 8, + "totalThreads": 16, + "memoryCapacityGB": 128, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 2, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 5 + } + ], + "computeMachines": [ + { + "properties": { + "vendor": "Dell", + "model": "PowerEdge R750", + "generation": "8", + "hardwareVersion": "3", + "bootstrapProtocol": "PXE", + "cpuSockets": 2, + "cpuCores": 28, + "totalThreads": 112, + "memoryCapacityGB": 512, + "disks": [ + { + "capacityGB": 893, + "type": "SSD", + "connection": "SAS" + } + ], + "networkInterfaces": [ + { + "address": "04:00.0", + "physicalSlot": 1, + "portCount": 2, + "portSpeed": 1, + "deviceConnectionType": "PCI", + "vendor": "Broadcom Corp", + "model": "Broadcom Gigabit Ethernet BCM5720" + } + ] + }, + "rackSlot": 1 + } + ], + "storageAppliances": [ + { + "properties": { + "capacityGB": 9100, + "model": "x70r3-9" + }, + "rackSlot": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Create.json new file mode 100644 index 000000000000..7bbf30f95495 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName", + "rackParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Delete.json new file mode 100644 index 000000000000..0a8294ff0cb2 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Get.json new file mode 100644 index 000000000000..739ba02ff55b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListByResourceGroup.json new file mode 100644 index 000000000000..96d8f17fcb82 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListBySubscription.json new file mode 100644 index 000000000000..abb583c4365d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Patch.json new file mode 100644 index 000000000000..5b0e3059c8bf --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Racks_Patch.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName", + "rackUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "rackLocation": "Rack 2B" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Create.json new file mode 100644 index 000000000000..32fa397823d1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Create.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser", + "password": "{password}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Delete.json new file mode 100644 index 000000000000..1481c42651bb --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json new file mode 100644 index 000000000000..bb554ee646a5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json new file mode 100644 index 000000000000..cf76ee464868 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceEnableRemoteVendorManagementParameters": { + "supportEndpoints": [ + "10.0.0.0/24" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Get.json new file mode 100644 index 000000000000..81a3bb03a5ca --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListByResourceGroup.json new file mode 100644 index 000000000000..1c8bc687fceb --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListBySubscription.json new file mode 100644 index 000000000000..34ea8d899ae8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Patch.json new file mode 100644 index 000000000000..0506f10df746 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/StorageAppliances_Patch.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "serialNumber": "BM1219XXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2", + "manufacturer": "Contoso Storage", + "model": "ArrayStore-Flash70", + "secretRotationStatus": [ + { + "secretType": "Storage Appliance User", + "lastRotationTime": "2023-09-30T13:27:23.103Z", + "rotationPeriodDays": 60, + "expirePeriodDays": 90, + "secretArchiveReference": { + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName", + "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-storage-appliance-credential-manager-ffffffff", + "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b" + } + } + ], + "version": "9.9.9" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Create.json new file mode 100644 index 000000000000..6cc20f4551a7 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Create.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName", + "trunkedNetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Delete.json new file mode 100644 index 000000000000..b53626ec510e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Get.json new file mode 100644 index 000000000000..eeb982c2ed7f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..ba05ca28a6c5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListBySubscription.json new file mode 100644 index 000000000000..41202d39c59f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Patch.json new file mode 100644 index 000000000000..bf956679de31 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/TrunkedNetworks_Patch.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName", + "trunkedNetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Create.json new file mode 100644 index 000000000000..cd08f253e462 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Create.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachineParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "password": "{password}", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Accepted", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Delete.json new file mode 100644 index 000000000000..36b70750e489 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Get.json new file mode 100644 index 000000000000..efdc37884834 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListByResourceGroup.json new file mode 100644 index 000000000000..f8ab2979351a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListByResourceGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListBySubscription.json new file mode 100644 index 000000000000..78c1e441321e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Patch.json new file mode 100644 index 000000000000..397b93bb4333 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Patch.json @@ -0,0 +1,199 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachineUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "vmImageRepositoryCredentials": { + "username": "myuser", + "password": "{password}", + "registryUrl": "myacr.azurecr.io" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Accepted", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_PowerOff.json new file mode 100644 index 000000000000..803f95731ca6 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_PowerOff.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachinePowerOffParameters": { + "skipShutdown": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Reimage.json new file mode 100644 index 000000000000..5bdecc5465e8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Reimage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Restart.json new file mode 100644 index 000000000000..5bdecc5465e8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Start.json new file mode 100644 index 000000000000..5bdecc5465e8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/VirtualMachines_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Create.json new file mode 100644 index 000000000000..6c0c2543d462 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName", + "volumeParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Delete.json new file mode 100644 index 000000000000..c697c060db60 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Get.json new file mode 100644 index 000000000000..2b5e097d05e8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListByResourceGroup.json new file mode 100644 index 000000000000..977d0614aa97 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListBySubscription.json new file mode 100644 index 000000000000..9888f6dbef07 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Patch.json new file mode 100644 index 000000000000..402a1c4753d5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/examples/Volumes_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName", + "volumeUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/networkcloud.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/networkcloud.json new file mode 100644 index 000000000000..5ec760b2ae7e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2024-06-01-preview/networkcloud.json @@ -0,0 +1,13441 @@ +{ + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "description": "The Network Cloud APIs provide management of the Azure Operator Nexus compute resources such as on-premises clusters, hardware resources, and workload infrastructure resources.", + "title": "NetworkCloud", + "version": "2024-06-01-preview" + }, + "host": "management.azure.com", + "paths": { + "/providers/Microsoft.NetworkCloud/operations": { + "get": { + "description": "Get a list of all available resource provider operations. It contains a URL link to get the next set of results.", + "summary": "List resource provider operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List resource provider operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/bareMetalMachines": { + "get": { + "description": "Get a list of bare metal machines in the provided subscription.", + "summary": "List bare metal machines in the subscription.", + "operationId": "BareMetalMachines_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List bare metal machines for subscription": { + "$ref": "./examples/BareMetalMachines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/cloudServicesNetworks": { + "get": { + "description": "Get a list of cloud services networks in the provided subscription.", + "summary": "List cloud services networks in the subscription.", + "operationId": "CloudServicesNetworks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/CloudServicesNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cloud services networks for subscription": { + "$ref": "./examples/CloudServicesNetworks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusterManagers": { + "get": { + "description": "Get a list of cluster managers in the provided subscription.", + "summary": "List cluster managers in the subscription.", + "operationId": "ClusterManagers_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterManagerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cluster managers for subscription": { + "$ref": "./examples/ClusterManagers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusters": { + "get": { + "description": "Get a list of clusters in the provided subscription.", + "summary": "List clusters in the subscription.", + "operationId": "Clusters_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List clusters for subscription": { + "$ref": "./examples/Clusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/kubernetesClusters": { + "get": { + "description": "Get a list of Kubernetes clusters in the provided subscription.", + "summary": "List Kubernetes clusters in the subscription.", + "operationId": "KubernetesClusters_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Kubernetes clusters for subscription": { + "$ref": "./examples/KubernetesClusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l2Networks": { + "get": { + "description": "Get a list of layer 2 (L2) networks in the provided subscription.", + "summary": "List layer 2 (L2) networks in the subscription.", + "operationId": "L2Networks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L2NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L2 networks for subscription": { + "$ref": "./examples/L2Networks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l3Networks": { + "get": { + "description": "Get a list of layer 3 (L3) networks in the provided subscription.", + "summary": "List layer 3 (L3) networks in the subscription.", + "operationId": "L3Networks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L3NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L3 networks for subscription": { + "$ref": "./examples/L3Networks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus": { + "get": { + "description": "Get a list of rack SKUs in the provided subscription.", + "summary": "List rack SKUs in the subscription.", + "operationId": "RackSkus_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackSkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List rack SKUs for subscription": { + "$ref": "./examples/RackSkus_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus/{rackSkuName}": { + "get": { + "description": "Get the properties of the provided rack SKU.", + "summary": "Retrieve the rack SKU.", + "operationId": "RackSkus_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/RackSkuNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackSku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get rack SKU resource": { + "$ref": "./examples/RackSkus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/racks": { + "get": { + "description": "Get a list of racks in the provided subscription.", + "summary": "List racks in the subscription.", + "operationId": "Racks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List racks for subscription": { + "$ref": "./examples/Racks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/storageAppliances": { + "get": { + "description": "Get a list of storage appliances in the provided subscription.", + "summary": "List storage appliances in the subscription.", + "operationId": "StorageAppliances_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/StorageApplianceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List storage appliances for subscription": { + "$ref": "./examples/StorageAppliances_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/trunkedNetworks": { + "get": { + "description": "Get a list of trunked networks in the provided subscription.", + "summary": "List trunked networks in the subscription.", + "operationId": "TrunkedNetworks_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/TrunkedNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List trunked networks for subscription": { + "$ref": "./examples/TrunkedNetworks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/virtualMachines": { + "get": { + "description": "Get a list of virtual machines in the provided subscription.", + "summary": "List virtual machines in the subscription.", + "operationId": "VirtualMachines_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VirtualMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List virtual machines for subscription": { + "$ref": "./examples/VirtualMachines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/volumes": { + "get": { + "description": "Get a list of volumes in the provided subscription.", + "summary": "List volumes in the subscription.", + "operationId": "Volumes_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List volume for subscription": { + "$ref": "./examples/Volumes_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines": { + "get": { + "description": "Get a list of bare metal machines in the provided resource group.", + "summary": "List bare metal machines in the resource group.", + "operationId": "BareMetalMachines_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List bare metal machines for resource group": { + "$ref": "./examples/BareMetalMachines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}": { + "get": { + "description": "Get properties of the provided bare metal machine.", + "summary": "Retrieve the bare metal machine.", + "operationId": "BareMetalMachines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get bare metal machine": { + "$ref": "./examples/BareMetalMachines_Get.json" + } + } + }, + "put": { + "description": "Create a new bare metal machine or update the properties of the existing one.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Create or update the bare metal machine.", + "operationId": "BareMetalMachines_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update bare metal machine": { + "$ref": "./examples/BareMetalMachines_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided bare metal machine.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Delete the bare metal machine.", + "operationId": "BareMetalMachines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete bare metal machine": { + "$ref": "./examples/BareMetalMachines_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.", + "summary": "Patch the bare metal machine.", + "operationId": "BareMetalMachines_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachinePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/BareMetalMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch bare metal machine": { + "$ref": "./examples/BareMetalMachines_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/cordon": { + "post": { + "description": "Cordon the provided bare metal machine's Kubernetes node.", + "summary": "Cordon the bare metal machine.", + "operationId": "BareMetalMachines_Cordon", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineCordonParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachineCordonParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cordon bare metal machine": { + "$ref": "./examples/BareMetalMachines_Cordon.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/powerOff": { + "post": { + "description": "Power off the provided bare metal machine.", + "summary": "Power off the bare metal machine.", + "operationId": "BareMetalMachines_PowerOff", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachinePowerOffParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachinePowerOffParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Power off bare metal machine": { + "$ref": "./examples/BareMetalMachines_PowerOff.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/reimage": { + "post": { + "description": "Reimage the provided bare metal machine.", + "summary": "Reimage the bare metal machine.", + "operationId": "BareMetalMachines_Reimage", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Reimage bare metal machine": { + "$ref": "./examples/BareMetalMachines_Reimage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/replace": { + "post": { + "description": "Replace the provided bare metal machine.", + "summary": "Replace (service) the bare metal machine.", + "operationId": "BareMetalMachines_Replace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineReplaceParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachineReplaceParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Replace bare metal machine": { + "$ref": "./examples/BareMetalMachines_Replace.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/restart": { + "post": { + "description": "Restart the provided bare metal machine.", + "summary": "Restart the bare metal machine.", + "operationId": "BareMetalMachines_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart bare metal machine": { + "$ref": "./examples/BareMetalMachines_Restart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runCommand": { + "post": { + "description": "Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.", + "summary": "Run the command on the bare metal machine.", + "operationId": "BareMetalMachines_RunCommand", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineRunCommandParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineRunCommandParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Run command on bare metal machine": { + "$ref": "./examples/BareMetalMachines_RunCommand.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runDataExtracts": { + "post": { + "description": "Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.", + "summary": "Run data extraction for a bare metal machine.", + "operationId": "BareMetalMachines_RunDataExtracts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineRunDataExtractsParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineRunDataExtractsParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Run data extraction on bare metal machine": { + "$ref": "./examples/BareMetalMachines_RunDataExtracts.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runReadCommands": { + "post": { + "description": "Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.", + "summary": "Run read-only commands against a bare metal machine.", + "operationId": "BareMetalMachines_RunReadCommands", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineRunReadCommandsParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineRunReadCommandsParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Run and retrieve output from read only commands on bare metal machine.": { + "$ref": "./examples/BareMetalMachines_RunReadCommands.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/start": { + "post": { + "description": "Start the provided bare metal machine.", + "summary": "Start the bare metal machine.", + "operationId": "BareMetalMachines_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start bare metal machine": { + "$ref": "./examples/BareMetalMachines_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/uncordon": { + "post": { + "description": "Uncordon the provided bare metal machine's Kubernetes node.", + "summary": "Uncordon the bare metal machine.", + "operationId": "BareMetalMachines_Uncordon", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Uncordon bare metal machine": { + "$ref": "./examples/BareMetalMachines_Uncordon.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks": { + "get": { + "description": "Get a list of cloud services networks in the provided resource group.", + "summary": "List cloud services networks in the resource group.", + "operationId": "CloudServicesNetworks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/CloudServicesNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cloud services networks for resource group": { + "$ref": "./examples/CloudServicesNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName}": { + "get": { + "description": "Get properties of the provided cloud services network.", + "summary": "Retrieve the cloud services network.", + "operationId": "CloudServicesNetworks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Get.json" + } + } + }, + "put": { + "description": "Create a new cloud services network or update the properties of the existing cloud services network.", + "summary": "Create or update the cloud services network.", + "operationId": "CloudServicesNetworks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "cloudServicesNetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided cloud services network.", + "summary": "Delete the cloud services network.", + "operationId": "CloudServicesNetworks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update properties of the provided cloud services network, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch the cloud services network.", + "operationId": "CloudServicesNetworks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CloudServicesNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "cloudServicesNetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/CloudServicesNetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/CloudServicesNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch cloud services network": { + "$ref": "./examples/CloudServicesNetworks_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers": { + "get": { + "description": "Get a list of cluster managers in the provided resource group.", + "summary": "List cluster managers in the resource group.", + "operationId": "ClusterManagers_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterManagerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List cluster managers for resource group": { + "$ref": "./examples/ClusterManagers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}": { + "get": { + "description": "Get the properties of the provided cluster manager.", + "summary": "Retrieve the cluster manager.", + "operationId": "ClusterManagers_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get cluster manager": { + "$ref": "./examples/ClusterManagers_Get.json" + } + } + }, + "put": { + "description": "Create a new cluster manager or update properties of the cluster manager if it exists.", + "summary": "Create or update the cluster manager.", + "operationId": "ClusterManagers_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + }, + { + "description": "The request body.", + "name": "clusterManagerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterManager" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/ClusterManager" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/ClusterManager" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update cluster manager": { + "$ref": "./examples/ClusterManagers_Create.json" + }, + "Create or update cluster manager with user assigned identity": { + "$ref": "./examples/ClusterManagers_Create_Uami.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided cluster manager.", + "summary": "Delete the cluster manager.", + "operationId": "ClusterManagers_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete cluster manager": { + "$ref": "./examples/ClusterManagers_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.", + "summary": "Patch the cluster manager.", + "operationId": "ClusterManagers_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterManagerNameParameter" + }, + { + "description": "The request body.", + "name": "clusterManagerUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterManagerPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/ClusterManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch cluster manager": { + "$ref": "./examples/ClusterManagers_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters": { + "get": { + "description": "Get a list of clusters in the provided resource group.", + "summary": "List clusters in the resource group.", + "operationId": "Clusters_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List clusters for resource group": { + "$ref": "./examples/Clusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}": { + "get": { + "description": "Get properties of the provided cluster.", + "summary": "Retrieve the cluster.", + "operationId": "Clusters_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get cluster": { + "$ref": "./examples/Clusters_Get.json" + } + } + }, + "put": { + "description": "Create a new cluster or update the properties of the cluster if it exists.", + "summary": "Create or update the cluster.", + "operationId": "Clusters_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Cluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update cluster": { + "$ref": "./examples/Clusters_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided cluster.", + "summary": "Delete the cluster.", + "operationId": "Clusters_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete cluster": { + "$ref": "./examples/Clusters_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.", + "summary": "Patch the cluster.", + "operationId": "Clusters_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/Cluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch cluster AggregatorOrSingleRackDefinition": { + "$ref": "./examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json" + }, + "Patch cluster command output": { + "$ref": "./examples/Clusters_Patch_CommandOutput.json" + }, + "Patch cluster location": { + "$ref": "./examples/Clusters_Patch_Location.json" + }, + "Patch runtime protection configuration": { + "$ref": "./examples/Clusters_Patch_RuntimeProtectionConfiguration.json" + }, + "Patch secret archive": { + "$ref": "./examples/Clusters_Patch_SecretArchive.json" + }, + "Patch update strategy": { + "$ref": "./examples/Clusters_Patch_UpdateStrategy.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets": { + "get": { + "description": "Get a list of bare metal machine key sets for the provided cluster.", + "summary": "List bare metal machine key sets of the cluster.", + "operationId": "BareMetalMachineKeySets_ListByCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List bare metal machine key sets of the cluster": { + "$ref": "./examples/BareMetalMachineKeySets_ListByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName}": { + "get": { + "description": "Get bare metal machine key set of the provided cluster.", + "summary": "Retrieve the bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Get.json" + } + } + }, + "put": { + "description": "Create a new bare metal machine key set or update the existing one for the provided cluster.", + "summary": "Create or update the bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineKeySetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the bare metal machine key set of the provided cluster.", + "summary": "Delete the bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch bare metal machine key set of the cluster.", + "operationId": "BareMetalMachineKeySets_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bareMetalMachineKeySetUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySetPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/BareMetalMachineKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch bare metal machine key set of cluster": { + "$ref": "./examples/BareMetalMachineKeySets_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets": { + "get": { + "description": "Get a list of baseboard management controller key sets for the provided cluster.", + "summary": "List baseboard management controller key sets of the cluster.", + "operationId": "BmcKeySets_ListByCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BmcKeySetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List baseboard management controller key sets of the cluster": { + "$ref": "./examples/BmcKeySets_ListByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName}": { + "get": { + "description": "Get baseboard management controller key set of the provided cluster.", + "summary": "Retrieve the baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Get.json" + } + } + }, + "put": { + "description": "Create a new baseboard management controller key set or update the existing one for the provided cluster.", + "summary": "Create or update the baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bmcKeySetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the baseboard management controller key set of the provided cluster.", + "summary": "Delete the baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of baseboard management controller key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch baseboard management controller key set of the cluster.", + "operationId": "BmcKeySets_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/BmcKeySetNameParameter" + }, + { + "description": "The request body.", + "name": "bmcKeySetUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/BmcKeySetPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/BmcKeySet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch baseboard management controller key set of cluster": { + "$ref": "./examples/BmcKeySets_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/continueUpdateVersion": { + "post": { + "description": "Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.", + "summary": "Continue a paused update to the cluster version.", + "operationId": "Clusters_ContinueUpdateVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterContinueUpdateVersionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterContinueUpdateVersionParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Continue update cluster version": { + "$ref": "./examples/Clusters_ContinueUpdateVersion.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy": { + "post": { + "description": "Deploy the cluster using the rack configuration provided during creation.", + "summary": "Deploy the cluster.", + "operationId": "Clusters_Deploy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterDeployParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterDeployParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploy cluster": { + "$ref": "./examples/Clusters_Deploy.json" + }, + "Deploy cluster skipping validation": { + "$ref": "./examples/Clusters_Deploy_SkipValidation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations": { + "get": { + "description": "Get a list of metrics configurations for the provided cluster.", + "summary": "List metrics configurations of the cluster.", + "operationId": "MetricsConfigurations_ListByCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List metrics configurations of the cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_ListByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName}": { + "get": { + "description": "Get metrics configuration of the provided cluster.", + "summary": "Retrieve the metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Get.json" + } + } + }, + "put": { + "description": "Create new or update the existing metrics configuration of the provided cluster.", + "summary": "Create or update metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + }, + { + "description": "The request body.", + "name": "metricsConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the metrics configuration of the provided cluster.", + "summary": "Delete the metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.", + "summary": "Patch metrics configuration of the cluster.", + "operationId": "MetricsConfigurations_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/MetricsConfigurationName" + }, + { + "description": "The request body.", + "name": "metricsConfigurationUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfigurationPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/scanRuntime": { + "post": { + "description": "Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.", + "summary": "Execute a runtime protection scan on the cluster.", + "operationId": "Clusters_ScanRuntime", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "ClusterScanRuntimeParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterScanRuntimeParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Execute a runtime protection scan on the cluster": { + "$ref": "./examples/Clusters_ScanRuntime.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/updateVersion": { + "post": { + "description": "Update the version of the provided cluster to one of the available supported versions.", + "summary": "Update the cluster version.", + "operationId": "Clusters_UpdateVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "clusterUpdateVersionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateVersionParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update cluster version": { + "$ref": "./examples/Clusters_UpdateVersion.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters": { + "get": { + "description": "Get a list of Kubernetes clusters in the provided resource group.", + "summary": "List Kubernetes clusters in the resource group.", + "operationId": "KubernetesClusters_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Kubernetes clusters for resource group": { + "$ref": "./examples/KubernetesClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}": { + "get": { + "description": "Get properties of the provided the Kubernetes cluster.", + "summary": "Retrieve the Kubernetes cluster.", + "operationId": "KubernetesClusters_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Get.json" + } + } + }, + "put": { + "description": "Create a new Kubernetes cluster or update the properties of the existing one.", + "summary": "Create or update the Kubernetes cluster.", + "operationId": "KubernetesClusters_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Create.json" + }, + "Create or update Kubernetes cluster with a layer 2 load balancer": { + "$ref": "./examples/KubernetesClusters_L2LoadBalancer_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided Kubernetes cluster.", + "summary": "Delete the Kubernetes cluster.", + "operationId": "KubernetesClusters_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.", + "summary": "Patch the Kubernetes cluster.", + "operationId": "KubernetesClusters_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/KubernetesClusterPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools": { + "get": { + "description": "Get a list of agent pools for the provided Kubernetes cluster.", + "summary": "List agent pools of the Kubernetes cluster.", + "operationId": "AgentPools_ListByKubernetesCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/AgentPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List agent pools of the Kubernetes cluster": { + "$ref": "./examples/AgentPools_ListByKubernetesCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}": { + "get": { + "description": "Get properties of the provided Kubernetes cluster agent pool.", + "summary": "Retrieve the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Get.json" + } + } + }, + "put": { + "description": "Create a new Kubernetes cluster agent pool or update the properties of the existing one.", + "summary": "Create or update the Kubernetes cluster agent pool.", + "operationId": "AgentPools_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "description": "The request body.", + "name": "agentPoolParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided Kubernetes cluster agent pool.", + "summary": "Delete the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.", + "summary": "Patch the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "description": "The request body.", + "name": "agentPoolUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/AgentPoolPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features": { + "get": { + "description": "Get a list of features for the provided Kubernetes cluster.", + "summary": "List features for the Kubernetes cluster.", + "operationId": "KubernetesClusterFeatures_ListByKubernetesCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeatureList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List features for the Kubernetes cluster.": { + "$ref": "./examples/KubernetesClusterFeatures_ListByKubernetesCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features/{featureName}": { + "get": { + "description": "Get properties of the provided the Kubernetes cluster feature.", + "summary": "Retrieve the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Get.json" + } + } + }, + "put": { + "description": "Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.", + "summary": "Create or update the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterFeatureParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided Kubernetes cluster feature.", + "summary": "Delete the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided Kubernetes cluster feature.", + "summary": "Patch the Kubernetes cluster feature.", + "operationId": "KubernetesClusterFeatures_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterFeatureUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeaturePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/KubernetesClusterFeature" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Kubernetes cluster feature": { + "$ref": "./examples/KubernetesClusterFeatures_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/restartNode": { + "post": { + "description": "Restart a targeted node of a Kubernetes cluster.", + "summary": "Restart a targeted node.", + "operationId": "KubernetesClusters_RestartNode", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/KubernetesClusterNameParameter" + }, + { + "description": "The request body.", + "name": "kubernetesClusterRestartNodeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KubernetesClusterRestartNodeParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart a Kubernetes cluster node": { + "$ref": "./examples/KubernetesClusters_RestartNode.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks": { + "get": { + "description": "Get a list of layer 2 (L2) networks in the provided resource group.", + "summary": "List layer 2 (L2) networks in the resource group.", + "operationId": "L2Networks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L2NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L2 networks for resource group": { + "$ref": "./examples/L2Networks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName}": { + "get": { + "description": "Get properties of the provided layer 2 (L2) network.", + "summary": "Retrieve the layer 2 (L2) network.", + "operationId": "L2Networks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L2Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get L2 network": { + "$ref": "./examples/L2Networks_Get.json" + } + } + }, + "put": { + "description": "Create a new layer 2 (L2) network or update the properties of the existing network.", + "summary": "Create or update the layer 2 (L2) network.", + "operationId": "L2Networks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l2NetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/L2Network" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/L2Network" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/L2Network" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update L2 network": { + "$ref": "./examples/L2Networks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided layer 2 (L2) network.", + "summary": "Delete the layer 2 (L2) network.", + "operationId": "L2Networks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete L2 network": { + "$ref": "./examples/L2Networks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided layer 2 (L2) network.", + "summary": "Patch the layer 2 (L2) network.", + "operationId": "L2Networks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L2NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l2NetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/L2NetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/L2Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch L2 network": { + "$ref": "./examples/L2Networks_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks": { + "get": { + "description": "Get a list of layer 3 (L3) networks in the provided resource group.", + "summary": "List layer 3 (L3) networks in the resource group.", + "operationId": "L3Networks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L3NetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List L3 networks for resource group": { + "$ref": "./examples/L3Networks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName}": { + "get": { + "description": "Get properties of the provided layer 3 (L3) network.", + "summary": "Retrieve the layer 3 (L3) network.", + "operationId": "L3Networks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/L3Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get L3network": { + "$ref": "./examples/L3Networks_Get.json" + } + } + }, + "put": { + "description": "Create a new layer 3 (L3) network or update the properties of the existing network.", + "summary": "Create or update the layer 3 (L3) network.", + "operationId": "L3Networks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l3NetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/L3Network" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/L3Network" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/L3Network" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update L3 network": { + "$ref": "./examples/L3Networks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided layer 3 (L3) network.", + "summary": "Delete the layer 3 (L3) network.", + "operationId": "L3Networks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete L3 network": { + "$ref": "./examples/L3Networks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided layer 3 (L3) network.", + "summary": "Patch the layer 3 (L3) network.", + "operationId": "L3Networks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/L3NetworkNameParameter" + }, + { + "description": "The request body.", + "name": "l3NetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/L3NetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/L3Network" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch L3 network": { + "$ref": "./examples/L3Networks_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks": { + "get": { + "description": "Get a list of racks in the provided resource group.", + "summary": "List racks in the resource group.", + "operationId": "Racks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/RackList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List racks for resource group": { + "$ref": "./examples/Racks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}": { + "get": { + "description": "Get properties of the provided rack.", + "summary": "Retrieve the rack.", + "operationId": "Racks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Rack" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get rack": { + "$ref": "./examples/Racks_Get.json" + } + } + }, + "put": { + "description": "Create a new rack or update properties of the existing one.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Create or update the rack.", + "operationId": "Racks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + }, + { + "description": "The request body.", + "name": "rackParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Rack" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Rack" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Rack" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update rack": { + "$ref": "./examples/Racks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided rack.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Delete the rack.", + "operationId": "Racks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete rack": { + "$ref": "./examples/Racks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch properties of the provided rack, or update the tags associated with the rack. Properties and tag updates can be done independently.", + "summary": "Patch the rack.", + "operationId": "Racks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RackNameParameter" + }, + { + "description": "The request body.", + "name": "rackUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/RackPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Rack" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/Rack" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch rack": { + "$ref": "./examples/Racks_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances": { + "get": { + "description": "Get a list of storage appliances in the provided resource group.", + "summary": "List storage appliances in the resource group.", + "operationId": "StorageAppliances_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/StorageApplianceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List storage appliances for resource group": { + "$ref": "./examples/StorageAppliances_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}": { + "get": { + "description": "Get properties of the provided storage appliance.", + "summary": "Retrieve the storage appliance.", + "operationId": "StorageAppliances_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get storage appliance": { + "$ref": "./examples/StorageAppliances_Get.json" + } + } + }, + "put": { + "description": "Create a new storage appliance or update the properties of the existing one.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Create or update the storage appliance.", + "operationId": "StorageAppliances_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + }, + { + "description": "The request body.", + "name": "storageApplianceParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update storage appliance": { + "$ref": "./examples/StorageAppliances_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided storage appliance.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", + "summary": "Delete the storage appliance.", + "operationId": "StorageAppliances_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete storage appliance": { + "$ref": "./examples/StorageAppliances_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.", + "summary": "Patch the storage appliance.", + "operationId": "StorageAppliances_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + }, + { + "description": "The request body.", + "name": "storageApplianceUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/StorageAppliancePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/StorageAppliance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch storage appliance": { + "$ref": "./examples/StorageAppliances_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/disableRemoteVendorManagement": { + "post": { + "description": "Disable remote vendor management of the provided storage appliance.", + "summary": "Turn off remote vendor management for a storage appliance, if supported.", + "operationId": "StorageAppliances_DisableRemoteVendorManagement", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Turn off remote vendor management for storage appliance": { + "$ref": "./examples/StorageAppliances_DisableRemoteVendorManagement.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/enableRemoteVendorManagement": { + "post": { + "description": "Enable remote vendor management of the provided storage appliance.", + "summary": "Turn on remote vendor management for a storage appliance, if supported.", + "operationId": "StorageAppliances_EnableRemoteVendorManagement", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageApplianceNameParameter" + }, + { + "description": "The request body.", + "name": "storageApplianceEnableRemoteVendorManagementParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/StorageApplianceEnableRemoteVendorManagementParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Turn on remote vendor management for storage appliance": { + "$ref": "./examples/StorageAppliances_EnableRemoteVendorManagement.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks": { + "get": { + "description": "Get a list of trunked networks in the provided resource group.", + "summary": "List trunked networks in the resource group.", + "operationId": "TrunkedNetworks_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/TrunkedNetworkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Trunked networks for resource group": { + "$ref": "./examples/TrunkedNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName}": { + "get": { + "description": "Get properties of the provided trunked network.", + "summary": "Retrieve the trunked network.", + "operationId": "TrunkedNetworks_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Trunked network": { + "$ref": "./examples/TrunkedNetworks_Get.json" + } + } + }, + "put": { + "description": "Create a new trunked network or update the properties of the existing trunked network.", + "summary": "Create or update the trunked network.", + "operationId": "TrunkedNetworks_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "trunkedNetworkParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update trunked network": { + "$ref": "./examples/TrunkedNetworks_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided trunked network.", + "summary": "Delete the trunked network.", + "operationId": "TrunkedNetworks_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete trunked network": { + "$ref": "./examples/TrunkedNetworks_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided trunked network.", + "summary": "Patch the trunked network.", + "operationId": "TrunkedNetworks_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TrunkedNetworkNameParameter" + }, + { + "description": "The request body.", + "name": "trunkedNetworkUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/TrunkedNetworkPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/TrunkedNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch trunked network": { + "$ref": "./examples/TrunkedNetworks_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines": { + "get": { + "description": "Get a list of virtual machines in the provided resource group.", + "summary": "List virtual machines in the resource group.", + "operationId": "VirtualMachines_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VirtualMachineList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List virtual machines for resource group": { + "$ref": "./examples/VirtualMachines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}": { + "get": { + "description": "Get properties of the provided virtual machine.", + "summary": "Retrieve the virtual machine.", + "operationId": "VirtualMachines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get virtual machine": { + "$ref": "./examples/VirtualMachines_Get.json" + } + } + }, + "put": { + "description": "Create a new virtual machine or update the properties of the existing virtual machine.", + "summary": "Create or update the virtual machine.", + "operationId": "VirtualMachines_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "description": "The request body.", + "name": "virtualMachineParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update virtual machine": { + "$ref": "./examples/VirtualMachines_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided virtual machine.", + "summary": "Delete the virtual machine.", + "operationId": "VirtualMachines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete virtual machine": { + "$ref": "./examples/VirtualMachines_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.", + "summary": "Patch the virtual machine.", + "operationId": "VirtualMachines_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "description": "The request body.", + "name": "virtualMachineUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/VirtualMachinePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch virtual machine": { + "$ref": "./examples/VirtualMachines_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles": { + "get": { + "description": "Get a list of consoles for the provided virtual machine.", + "summary": "List consoles of the virtual machine.", + "operationId": "Consoles_ListByVirtualMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/ConsoleList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List consoles of the virtual machine": { + "$ref": "./examples/Consoles_ListByVirtualMachine.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}": { + "get": { + "description": "Get properties of the provided virtual machine console.", + "summary": "Retrieve the virtual machine console.", + "operationId": "Consoles_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Console" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get virtual machine console": { + "$ref": "./examples/Consoles_Get.json" + } + } + }, + "put": { + "description": "Create a new virtual machine console or update the properties of the existing virtual machine console.", + "summary": "Create or update the virtual machine console.", + "operationId": "Consoles_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "description": "The request body.", + "name": "consoleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Console" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Console" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Console" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update virtual machine console": { + "$ref": "./examples/Consoles_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided virtual machine console.", + "summary": "Delete the virtual machine console.", + "operationId": "Consoles_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete virtual machine console": { + "$ref": "./examples/Consoles_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.", + "summary": "Patch the virtual machine console.", + "operationId": "Consoles_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "description": "The request body.", + "name": "consoleUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ConsolePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Console" + } + }, + "202": { + "description": "The resource has been accepted for update.", + "schema": { + "$ref": "#/definitions/Console" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + }, + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch virtual machine console": { + "$ref": "./examples/Consoles_Patch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/powerOff": { + "post": { + "description": "Power off the provided virtual machine.", + "summary": "Power off the virtual machine.", + "operationId": "VirtualMachines_PowerOff", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + }, + { + "description": "The request body.", + "name": "virtualMachinePowerOffParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/VirtualMachinePowerOffParameters" + } + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Power off virtual machine": { + "$ref": "./examples/VirtualMachines_PowerOff.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/reimage": { + "post": { + "description": "Reimage the provided virtual machine.", + "summary": "Reimage the virtual machine.", + "operationId": "VirtualMachines_Reimage", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Reimage virtual machine": { + "$ref": "./examples/VirtualMachines_Reimage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/restart": { + "post": { + "description": "Restart the provided virtual machine.", + "summary": "Restart the virtual machine.", + "operationId": "VirtualMachines_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart virtual machine": { + "$ref": "./examples/VirtualMachines_Restart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/start": { + "post": { + "description": "Start the provided virtual machine.", + "summary": "Start the virtual machine.", + "operationId": "VirtualMachines_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualMachineNameParameter" + } + ], + "responses": { + "202": { + "description": "The action has been initiated for the resource.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start virtual machine": { + "$ref": "./examples/VirtualMachines_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes": { + "get": { + "description": "Get a list of volumes in the provided resource group.", + "summary": "List volumes in the resource group.", + "operationId": "Volumes_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource list has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List volumes for resource group": { + "$ref": "./examples/Volumes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}": { + "get": { + "description": "Get properties of the provided volume.", + "summary": "Retrieve the volume.", + "operationId": "Volumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource has been successfully retrieved.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get volume": { + "$ref": "./examples/Volumes_Get.json" + } + } + }, + "put": { + "description": "Create a new volume or update the properties of the existing one.", + "summary": "Create or update the volume.", + "operationId": "Volumes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "description": "The request body.", + "name": "volumeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Volume" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "201": { + "description": "The resource has been accepted for creation or update.", + "schema": { + "$ref": "#/definitions/Volume" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update volume": { + "$ref": "./examples/Volumes_Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Delete the provided volume.", + "summary": "Delete the volume.", + "operationId": "Volumes_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + } + ], + "responses": { + "202": { + "description": "The resource has been accepted for deletion.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "204": { + "description": "The resource has been successfully deleted or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete volume": { + "$ref": "./examples/Volumes_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "#/definitions/OperationStatusResult", + "final-state-via": "location" + } + }, + "patch": { + "description": "Update tags associated with the provided volume.", + "summary": "Patch the volume.", + "operationId": "Volumes_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "description": "The request body.", + "name": "volumeUpdateParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/VolumePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "The resource has been successfully updated.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch volume": { + "$ref": "./examples/Volumes_Patch.json" + } + } + } + } + }, + "definitions": { + "AadConfiguration": { + "type": "object", + "title": "AadConfiguration represents the Azure Active Directory Integration properties.", + "required": [ + "adminGroupObjectIds" + ], + "properties": { + "adminGroupObjectIds": { + "description": "The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster.", + "type": "array", + "minItems": 1, + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AdministrativeCredentials": { + "type": "object", + "title": "AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.", + "required": [ + "username", + "password" + ], + "properties": { + "password": { + "description": "The password of the administrator of the device used during initialization.", + "type": "string", + "minLength": 1, + "x-ms-secret": true + }, + "username": { + "description": "The username of the administrator of the device used during initialization.", + "type": "string", + "minLength": 1 + } + } + }, + "AdministratorConfiguration": { + "type": "object", + "title": "AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters.", + "properties": { + "adminUsername": { + "description": "The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sshPublicKeys": { + "description": "The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + } + } + }, + "AdministratorConfigurationPatch": { + "type": "object", + "title": "AdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.", + "properties": { + "sshPublicKeys": { + "description": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "keyData" + ] + } + } + }, + "AgentOptions": { + "type": "object", + "title": "AgentOptions are configurations that will be applied to each agent in an agent pool.", + "required": [ + "hugepagesCount" + ], + "properties": { + "hugepagesCount": { + "description": "The number of hugepages to allocate.", + "type": "integer", + "format": "int64" + }, + "hugepagesSize": { + "description": "The size of the hugepages to allocate.", + "type": "string", + "default": "2M", + "enum": [ + "2M", + "1G" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HugepagesSize" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPool": { + "type": "object", + "title": "AgentPool represents the agent pool of Kubernetes cluster.", + "required": [ + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/AgentPoolProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "AgentPoolConfiguration": { + "type": "object", + "title": "AgentPoolConfiguration specifies the configuration of a pool of nodes.", + "required": [ + "count", + "mode", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool." + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPoolList": { + "type": "object", + "title": "AgentPoolList represents a list of Kubernetes cluster agent pools.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of agent pools.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + } + } + } + }, + "AgentPoolPatchParameters": { + "type": "object", + "title": "AgentPoolPatchParameters represents the body of the request to patch the Kubernetes cluster agent pool.", + "properties": { + "properties": { + "$ref": "#/definitions/AgentPoolPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AgentPoolPatchProperties": { + "type": "object", + "title": "AgentPoolPatchProperties represents the properties of an agent pool that can be modified.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/NodePoolAdministratorConfigurationPatch", + "description": "The configuration of administrator credentials for the control plane nodes." + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + } + } + }, + "AgentPoolProperties": { + "type": "object", + "title": "AgentPoolProperties represents the properties of the Kubernetes cluster agent pool.", + "required": [ + "count", + "mode", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "detailedStatus": { + "description": "The current status of the agent pool.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The Kubernetes version running in this agent pool.", + "type": "string", + "readOnly": true + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the agent pool.", + "type": "string", + "enum": [ + "Accepted", + "Canceled", + "Deleting", + "Failed", + "InProgress", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolProvisioningState" + }, + "readOnly": true + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "title": "AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.", + "properties": { + "drainTimeout": { + "description": "The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.", + "type": "integer", + "format": "int64", + "maximum": 86400, + "minimum": 60 + }, + "maxSurge": { + "description": "The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.", + "type": "string" + }, + "maxUnavailable": { + "description": "The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.", + "type": "string" + } + } + }, + "AttachedNetworkConfiguration": { + "type": "object", + "title": "AttachedNetworkConfiguration represents the set of workload networks to attach to a resource.", + "properties": { + "l2Networks": { + "description": "The list of Layer 2 Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/L2NetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l3Networks": { + "description": "The list of Layer 3 Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/L3NetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "trunkedNetworks": { + "description": "The list of Trunked Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/TrunkedNetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AvailableUpgrade": { + "type": "object", + "title": "AvailableUpgrade represents an upgrade available for a Kubernetes cluster.", + "properties": { + "availabilityLifecycle": { + "description": "The version lifecycle indicator.", + "type": "string", + "enum": [ + "Preview", + "GenerallyAvailable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AvailabilityLifecycle" + }, + "readOnly": true + }, + "version": { + "description": "The version available for upgrading.", + "type": "string", + "readOnly": true + } + } + }, + "BareMetalMachine": { + "type": "object", + "title": "BareMetalMachine represents the physical machine in the rack.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/BareMetalMachineProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "BareMetalMachineCommandSpecification": { + "type": "object", + "title": "BareMetalMachineCommandSpecification represents the command and optional arguments to exercise against the bare metal machine.", + "required": [ + "command" + ], + "properties": { + "arguments": { + "description": "The list of string arguments that will be passed to the script in order as separate arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "command": { + "description": "The command to execute against the bare metal machine.", + "type": "string" + } + } + }, + "BareMetalMachineConfigurationData": { + "type": "object", + "title": "BareMetalMachineConfigurationData represents configuration for the bare metal machine.", + "required": [ + "rackSlot", + "bootMacAddress", + "bmcCredentials", + "bmcMacAddress", + "serialNumber" + ], + "properties": { + "bmcConnectionString": { + "description": "The connection string for the baseboard management controller including IP address and protocol.", + "type": "string", + "readOnly": true + }, + "bmcCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the baseboard management controller on this bare metal machine." + }, + "bmcMacAddress": { + "description": "The MAC address of the BMC for this machine.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "bootMacAddress": { + "description": "The MAC address associated with the PXE NIC card.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "machineDetails": { + "description": "The free-form additional information about the machine, e.g. an asset tag.", + "type": "string", + "maxLength": 256 + }, + "machineName": { + "description": "The user-provided name for the bare metal machine created from this specification.\nIf not provided, the machine name will be generated programmatically.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$" + }, + "rackSlot": { + "description": "The slot the physical machine is in the rack based on the BOM configuration.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1 + }, + "serialNumber": { + "description": "The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.", + "type": "string", + "maxLength": 64 + } + } + }, + "BareMetalMachineCordonParameters": { + "type": "object", + "title": "BareMetalMachineCordonParameters represents the body of the request to evacuate workloads from node on a bare metal machine.", + "properties": { + "evacuate": { + "description": "The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineEvacuate" + } + } + } + }, + "BareMetalMachineKeySet": { + "type": "object", + "title": "BareMetalMachineKeySet represents the bare metal machine key set.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/BareMetalMachineKeySetProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "BareMetalMachineKeySetList": { + "type": "object", + "title": "BareMetalMachineKeySetList represents a list of bare metal machine key sets.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of bare metal machine key sets.", + "type": "array", + "items": { + "$ref": "#/definitions/BareMetalMachineKeySet" + } + } + } + }, + "BareMetalMachineKeySetPatchParameters": { + "type": "object", + "title": "BareMetalMachineKeySetPatchParameters represents the body of the request to patch the bare metal machine key set.", + "properties": { + "properties": { + "$ref": "#/definitions/BareMetalMachineKeySetPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BareMetalMachineKeySetPatchProperties": { + "type": "object", + "title": "BareMetalMachineKeySetPatchProperties represents the properties of bare metal machine key set that can be patched.", + "properties": { + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the bare metal machines.", + "type": "string", + "format": "date-time" + }, + "jumpHostsAllowed": { + "description": "The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.", + "type": "array", + "items": { + "type": "string" + } + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + } + } + }, + "BareMetalMachineKeySetProperties": { + "type": "object", + "title": "BareMetalMachineKeySetProperties represents the properties of bare metal machine key set.", + "required": [ + "privilegeLevel", + "expiration", + "azureGroupId", + "jumpHostsAllowed", + "userList" + ], + "properties": { + "azureGroupId": { + "description": "The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "detailedStatus": { + "description": "The more detailed status of the key set.", + "type": "string", + "enum": [ + "AllActive", + "SomeInvalid", + "AllInvalid", + "Validating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the bare metal machines.", + "type": "string", + "format": "date-time" + }, + "jumpHostsAllowed": { + "description": "The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.", + "type": "array", + "items": { + "type": "string" + } + }, + "lastValidation": { + "description": "The last time this key set was validated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "osGroupName": { + "description": "The name of the group that users will be assigned to on the operating system of the machines.", + "type": "string", + "maxLength": 32, + "pattern": "^([A-Za-z]([A-Za-z0-9]*))$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privilegeLevel": { + "description": "The access level allowed for the users in this key set.", + "type": "string", + "enum": [ + "Standard", + "Superuser" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetPrivilegeLevel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the bare metal machine key set.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetProvisioningState" + }, + "readOnly": true + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + }, + "userListStatus": { + "description": "The status evaluation of each user.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUserStatus" + }, + "x-ms-identifiers": [ + "azureUserName" + ], + "readOnly": true + } + } + }, + "BareMetalMachineList": { + "type": "object", + "title": "BareMetalMachineList represents a list of bare metal machines.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of bare metal machines.", + "type": "array", + "items": { + "$ref": "#/definitions/BareMetalMachine" + } + } + } + }, + "BareMetalMachinePatchParameters": { + "type": "object", + "title": "BareMetalMachinePatchParameters represents the body of the request to patch bare metal machine properties.", + "properties": { + "properties": { + "$ref": "#/definitions/BareMetalMachinePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BareMetalMachinePatchProperties": { + "type": "object", + "title": "BareMetalMachinePatchProperties represents the properties of the bare metal machine that can be patched.", + "properties": { + "machineDetails": { + "description": "The details provided by the customer during the creation of rack manifests\nthat allows for custom data to be associated with this machine.", + "type": "string", + "maxLength": 256 + } + } + }, + "BareMetalMachinePowerOffParameters": { + "type": "object", + "title": "BareMetalMachinePowerOffParameters represents the body of the request to power off bare metal machine.", + "properties": { + "skipShutdown": { + "description": "The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineSkipShutdown" + } + } + } + }, + "BareMetalMachineProperties": { + "type": "object", + "title": "BareMetalMachineProperties represents the properties of a bare metal machine.", + "required": [ + "rackId", + "machineSkuId", + "rackSlot", + "machineName", + "bootMacAddress", + "bmcMacAddress", + "bmcCredentials", + "bmcConnectionString", + "machineDetails", + "serialNumber" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "bmcConnectionString": { + "description": "The connection string for the baseboard management controller including IP address and protocol.", + "type": "string" + }, + "bmcCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the baseboard management controller on this bare metal machine." + }, + "bmcMacAddress": { + "description": "The MAC address of the BMC device.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "bootMacAddress": { + "description": "The MAC address of a NIC connected to the PXE network.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "clusterId": { + "description": "The resource ID of the cluster this bare metal machine is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "cordonStatus": { + "description": "The cordon status of the bare metal machine.", + "type": "string", + "enum": [ + "Cordoned", + "Uncordoned" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineCordonStatus" + }, + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the bare metal machine.", + "type": "string", + "enum": [ + "Preparing", + "Error", + "Available", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hardwareInventory": { + "$ref": "#/definitions/HardwareInventory", + "description": "The hardware inventory, including information acquired from the model/sku information and from the ironic inspector.", + "readOnly": true + }, + "hardwareValidationStatus": { + "$ref": "#/definitions/HardwareValidationStatus", + "description": "The details of the latest hardware validation performed for this bare metal machine.", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "kubernetesNodeName": { + "description": "The name of this machine represented by the host object in the Cluster's Kubernetes control plane.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The version of Kubernetes running on this machine.", + "type": "string", + "readOnly": true + }, + "machineClusterVersion": { + "description": "The cluster version that has been applied to this machine during deployment or a version update.", + "type": "string" + }, + "machineDetails": { + "description": "The custom details provided by the customer.", + "type": "string", + "maxLength": 256 + }, + "machineName": { + "description": "The OS-level hostname assigned to this machine.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$" + }, + "machineRoles": { + "description": "The list of roles that are assigned to the cluster node running on this machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineSkuId": { + "description": "The unique internal identifier of the bare metal machine SKU.", + "type": "string" + }, + "oamIpv4Address": { + "description": "The IPv4 address that is assigned to the bare metal machine during the cluster deployment.", + "type": "string", + "readOnly": true + }, + "oamIpv6Address": { + "description": "The IPv6 address that is assigned to the bare metal machine during the cluster deployment.", + "type": "string", + "readOnly": true + }, + "osImage": { + "description": "The image that is currently provisioned to the OS disk.", + "type": "string", + "readOnly": true + }, + "powerState": { + "description": "The power state derived from the baseboard management controller.", + "type": "string", + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachinePowerState" + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the bare metal machine.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineProvisioningState" + }, + "readOnly": true + }, + "rackId": { + "description": "The resource ID of the rack where this bare metal machine resides.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/racks" + } + ] + } + }, + "rackSlot": { + "description": "The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1 + }, + "readyState": { + "description": "The indicator of whether the bare metal machine is ready to receive workloads.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineReadyState" + }, + "readOnly": true + }, + "runtimeProtectionStatus": { + "$ref": "#/definitions/RuntimeProtectionStatus", + "description": "The runtime protection status of the bare metal machine.", + "readOnly": true + }, + "secretRotationStatus": { + "description": "The list of statuses that represent secret rotation activity.", + "type": "array", + "items": { + "$ref": "#/definitions/SecretRotationStatus" + }, + "x-ms-identifiers": [ + "secretType" + ], + "readOnly": true + }, + "serialNumber": { + "description": "The serial number of the bare metal machine.", + "type": "string", + "maxLength": 64, + "minLength": 1 + }, + "serviceTag": { + "description": "The discovered value of the machine's service tag.", + "type": "string", + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "BareMetalMachineReplaceParameters": { + "type": "object", + "title": "BareMetalMachineReplaceParameters represents the body of the request to physically swap a bare metal machine for another.", + "properties": { + "bmcCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the baseboard management controller on this bare metal machine." + }, + "bmcMacAddress": { + "description": "The MAC address of the BMC device.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "bootMacAddress": { + "description": "The MAC address of a NIC connected to the PXE network.", + "type": "string", + "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + }, + "machineName": { + "description": "The OS-level hostname assigned to this machine.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$" + }, + "serialNumber": { + "description": "The serial number of the bare metal machine.", + "type": "string", + "maxLength": 64, + "minLength": 1 + } + } + }, + "BareMetalMachineRunCommandParameters": { + "type": "object", + "title": "BareMetalMachineRunCommandParameters represents the body of the request to execute a script on the bare metal machine.", + "required": [ + "script", + "limitTimeSeconds" + ], + "properties": { + "arguments": { + "description": "The list of string arguments that will be passed to the script in order as separate arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "limitTimeSeconds": { + "description": "The maximum time the script is allowed to run.\nIf the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).", + "type": "integer", + "format": "int64", + "maximum": 14400, + "minimum": 60 + }, + "script": { + "description": "The base64 encoded script to execute on the bare metal machine.", + "type": "string" + } + } + }, + "BareMetalMachineRunDataExtractsParameters": { + "type": "object", + "title": "BareMetalMachineRunDataExtractsParameters represents the body of request containing list of curated data extraction commands to run on the bare metal machine.", + "required": [ + "commands", + "limitTimeSeconds" + ], + "properties": { + "commands": { + "description": "The list of curated data extraction commands to be executed directly against the target machine.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/BareMetalMachineCommandSpecification" + }, + "x-ms-identifiers": [] + }, + "limitTimeSeconds": { + "description": "The maximum time the commands are allowed to run.\nIf the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).", + "type": "integer", + "format": "int64", + "maximum": 14400, + "minimum": 60 + } + } + }, + "BareMetalMachineRunReadCommandsParameters": { + "type": "object", + "title": "BareMetalMachineRunReadCommandsParameters represents the body of request containing list of read-only commands to run on the bare metal machine.", + "required": [ + "commands", + "limitTimeSeconds" + ], + "properties": { + "commands": { + "description": "The list of read-only commands to be executed directly against the target machine.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/BareMetalMachineCommandSpecification" + }, + "x-ms-identifiers": [] + }, + "limitTimeSeconds": { + "description": "The maximum time the commands are allowed to run.\nIf the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).", + "type": "integer", + "format": "int64", + "maximum": 14400, + "minimum": 60 + } + } + }, + "BgpAdvertisement": { + "type": "object", + "title": "BgpAdvertisement represents the association of IP address pools to the communities and peers.", + "required": [ + "ipAddressPools" + ], + "properties": { + "advertiseToFabric": { + "description": "The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AdvertiseToFabric" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "communities": { + "description": "The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAddressPools": { + "description": "The names of the IP address pools associated with this announcement.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peers": { + "description": "The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "BgpServiceLoadBalancerConfiguration": { + "type": "object", + "title": "BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer.", + "properties": { + "bgpAdvertisements": { + "description": "The association of IP address pools to the communities and peers, allowing for announcement of IPs.", + "type": "array", + "items": { + "$ref": "#/definitions/BgpAdvertisement" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpPeers": { + "description": "The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadBalancerBgpPeer" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "fabricPeeringEnabled": { + "description": "The indicator to specify if the load balancer peers with the network fabric.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "FabricPeeringEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAddressPools": { + "description": "The list of pools of IP addresses that can be allocated to load balancer services.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressPool" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "BmcKeySet": { + "type": "object", + "title": "BmcKeySet represents the baseboard management controller key set.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/BmcKeySetProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "BmcKeySetList": { + "type": "object", + "title": "BmcKeySetList represents a list of baseboard management controller key sets.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of baseboard management controller key sets.", + "type": "array", + "items": { + "$ref": "#/definitions/BmcKeySet" + } + } + } + }, + "BmcKeySetPatchParameters": { + "type": "object", + "title": "BmcKeySetPatchParameters represents the body of the request to patch the baseboard management controller key set.", + "properties": { + "properties": { + "$ref": "#/definitions/BmcKeySetPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BmcKeySetPatchProperties": { + "type": "object", + "title": "BmcKeySetPatchProperties represents the properties of baseboard management controller key set that are patchable.", + "properties": { + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the baseboard management controllers.", + "type": "string", + "format": "date-time" + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + } + } + }, + "BmcKeySetProperties": { + "type": "object", + "title": "BmcKeySetProperties represents the properties of baseboard management controller key set.", + "required": [ + "privilegeLevel", + "expiration", + "azureGroupId", + "userList" + ], + "properties": { + "azureGroupId": { + "description": "The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "detailedStatus": { + "description": "The more detailed status of the key set.", + "type": "string", + "enum": [ + "AllActive", + "SomeInvalid", + "AllInvalid", + "Validating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BmcKeySetDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "expiration": { + "description": "The date and time after which the users in this key set will be removed from the baseboard management controllers.", + "type": "string", + "format": "date-time" + }, + "lastValidation": { + "description": "The last time this key set was validated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "privilegeLevel": { + "description": "The access level allowed for the users in this key set.", + "type": "string", + "enum": [ + "ReadOnly", + "Administrator" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BmcKeySetPrivilegeLevel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the baseboard management controller key set.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BmcKeySetProvisioningState" + }, + "readOnly": true + }, + "userList": { + "description": "The unique list of permitted users.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUser" + }, + "x-ms-identifiers": [ + "azureUserName" + ] + }, + "userListStatus": { + "description": "The status evaluation of each user.", + "type": "array", + "items": { + "$ref": "#/definitions/KeySetUserStatus" + }, + "x-ms-identifiers": [ + "azureUserName" + ], + "readOnly": true + } + } + }, + "CloudServicesNetwork": { + "description": "Upon creation, the additional services that are provided by the platform will be allocated and\nrepresented in the status of this resource. All resources associated with this cloud services network will be part\nof the same layer 2 (L2) isolation domain. At least one service network must be created but may be reused across many\nvirtual machines and/or Hybrid AKS clusters.", + "type": "object", + "title": "CloudServicesNetwork represents additional egress information that will be used by associated virtual machines or hybrid AKS clusters.", + "required": [ + "extendedLocation" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/CloudServicesNetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "CloudServicesNetworkList": { + "type": "object", + "title": "CloudServicesNetworkList represents a list of cloud services networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of cloud services networks.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudServicesNetwork" + } + } + } + }, + "CloudServicesNetworkPatchParameters": { + "type": "object", + "title": "CloudServicesNetworkPatchParameters represents the body of the request to patch the cloud services network.", + "properties": { + "properties": { + "$ref": "#/definitions/CloudServicesNetworkPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CloudServicesNetworkPatchProperties": { + "type": "object", + "title": "CloudServicesNetworkPatchProperties represents the properties of the cloud services network that can be updated using a patch request.", + "properties": { + "additionalEgressEndpoints": { + "description": "The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/EgressEndpoint" + }, + "x-ms-identifiers": [] + }, + "enableDefaultEgressEndpoints": { + "description": "The indicator of whether the platform default endpoints are allowed for the egress traffic.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkEnableDefaultEgressEndpoints" + } + } + } + }, + "CloudServicesNetworkProperties": { + "type": "object", + "title": "CloudServicesNetworkProperties represents properties of the cloud services network.", + "properties": { + "additionalEgressEndpoints": { + "description": "The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/EgressEndpoint" + }, + "x-ms-identifiers": [] + }, + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this cloud services network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the cloud services network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "enableDefaultEgressEndpoints": { + "description": "The indicator of whether the platform default endpoints are allowed for the egress traffic.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkEnableDefaultEgressEndpoints" + } + }, + "enabledEgressEndpoints": { + "description": "The full list of additional and default egress endpoints that are currently enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/EgressEndpoint" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "interfaceName": { + "description": "The name of the interface that will be present in the virtual machine to represent this network.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the cloud services network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CloudServicesNetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "Cluster": { + "type": "object", + "title": "Cluster represents the on-premises Network Cloud cluster.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster manager associated with the cluster." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity for the resource." + }, + "properties": { + "$ref": "#/definitions/ClusterProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ClusterAvailableUpgradeVersion": { + "type": "object", + "title": "ClusterAvailableUpgradeVersion represents the various cluster upgrade parameters.", + "properties": { + "controlImpact": { + "description": "The indicator of whether the control plane will be impacted during the upgrade.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ControlImpact" + }, + "readOnly": true + }, + "expectedDuration": { + "description": "The expected duration needed for this upgrade.", + "type": "string", + "readOnly": true + }, + "impactDescription": { + "description": "The impact description including the specific details and release notes.", + "type": "string", + "readOnly": true + }, + "supportExpiryDate": { + "description": "The last date the version of the platform is supported.", + "type": "string", + "readOnly": true + }, + "targetClusterVersion": { + "description": "The target version this cluster will be upgraded to.", + "type": "string", + "readOnly": true + }, + "workloadImpact": { + "description": "The indicator of whether the workload will be impacted during the upgrade.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "WorkloadImpact" + }, + "readOnly": true + } + } + }, + "ClusterAvailableVersion": { + "type": "object", + "title": "ClusterAvailableVersion represents the cluster version that the cluster manager can be asked to create and manage.", + "properties": { + "supportExpiryDate": { + "description": "The last date the version of the platform is supported.", + "type": "string", + "readOnly": true + }, + "targetClusterVersion": { + "description": "The version of the cluster to be deployed.", + "type": "string", + "readOnly": true + } + } + }, + "ClusterCapacity": { + "type": "object", + "title": "ClusterCapacity represents various details regarding compute capacity.", + "properties": { + "availableApplianceStorageGB": { + "description": "The remaining appliance-based storage in GB available for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "availableCoreCount": { + "description": "The remaining number of cores that are available in this cluster for workload use.", + "type": "integer", + "format": "int64" + }, + "availableHostStorageGB": { + "description": "The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "availableMemoryGB": { + "description": "The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "totalApplianceStorageGB": { + "description": "The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "totalCoreCount": { + "description": "The total number of cores that are supported by this cluster for workload use.", + "type": "integer", + "format": "int64" + }, + "totalHostStorageGB": { + "description": "The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + }, + "totalMemoryGB": { + "description": "The total memory supported by this cluster for workload use. Measured in gibibytes.", + "type": "integer", + "format": "int64" + } + } + }, + "ClusterContinueUpdateVersionParameters": { + "type": "object", + "title": "ClusterContinueUpdateVersionParameters represents the body of the request to continue the update of a cluster version.", + "properties": { + "machineGroupTargetingMode": { + "description": "The mode by which the cluster will target the next grouping of servers to continue the update.", + "type": "string", + "default": "AlphaByRack", + "enum": [ + "AlphaByRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterContinueUpdateVersionMachineGroupTargetingMode" + } + } + } + }, + "ClusterDeployParameters": { + "type": "object", + "title": "ClusterDeployParameters represents the body of the request to deploy cluster.", + "properties": { + "skipValidationsForMachines": { + "description": "The names of bare metal machines in the cluster that should be skipped during environment validation.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ClusterList": { + "type": "object", + "title": "ClusterList represents a list of clusters.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + } + } + }, + "ClusterManager": { + "type": "object", + "title": "ClusterManager represents a control-plane to manage one or more on-premises clusters.", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the cluster manager." + }, + "properties": { + "$ref": "#/definitions/ClusterManagerProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ClusterManagerList": { + "type": "object", + "title": "ClusterManagerList represents a list of cluster manager objects.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of cluster managers.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterManager" + } + } + } + }, + "ClusterManagerPatchParameters": { + "type": "object", + "title": "ClusterManagerPatchParameters represents the body of the request to patch the cluster properties.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity for the resource." + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterManagerProperties": { + "type": "object", + "title": "ClusterManagerProperties represents the properties of a cluster manager.", + "required": [ + "fabricControllerId" + ], + "properties": { + "analyticsWorkspaceId": { + "description": "The resource ID of the Log Analytics workspace that is used for the logs collection.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterVersions": { + "description": "The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterAvailableVersion" + }, + "x-ms-identifiers": [ + "targetClusterVersion" + ], + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed status that provides additional information about the cluster manager.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning", + "ProvisioningFailed", + "Updating", + "UpdateFailed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterManagerDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "fabricControllerId": { + "description": "The resource ID of the fabric controller that has one to one mapping with the cluster manager.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "The configuration of the managed resource group associated with the resource." + }, + "managerExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the cluster manager.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterManagerProvisioningState" + }, + "readOnly": true + }, + "vmSize": { + "description": "Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ClusterMetricsConfiguration": { + "type": "object", + "title": "ClusterMetricsConfiguration represents the metrics configuration of an on-premises Network Cloud cluster.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/ClusterMetricsConfigurationProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ClusterMetricsConfigurationList": { + "type": "object", + "title": "ClusterMetricsConfigurationList represents a list of metrics configuration of the cluster.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of metrics configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterMetricsConfiguration" + } + } + } + }, + "ClusterMetricsConfigurationPatchParameters": { + "type": "object", + "title": "ClusterMetricsConfigurationPatchParameters represents the body of the request to patch the metrics configuration of cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/ClusterMetricsConfigurationPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterMetricsConfigurationPatchProperties": { + "type": "object", + "title": "ClusterMetricsConfigurationPatchProperties represents the properties of metrics configuration for the cluster for patching.", + "properties": { + "collectionInterval": { + "description": "The interval in minutes by which metrics will be collected.", + "type": "integer", + "format": "int64", + "maximum": 1440, + "minimum": 1 + }, + "enabledMetrics": { + "description": "The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ClusterMetricsConfigurationProperties": { + "type": "object", + "title": "ClusterMetricsConfigurationProperties represents the properties of metrics configuration for the cluster.", + "required": [ + "collectionInterval" + ], + "properties": { + "collectionInterval": { + "description": "The interval in minutes by which metrics will be collected.", + "type": "integer", + "format": "int64", + "maximum": 1440, + "minimum": 1 + }, + "detailedStatus": { + "description": "The more detailed status of the metrics configuration.", + "type": "string", + "enum": [ + "Processing", + "Applied", + "Error" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterMetricsConfigurationDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "disabledMetrics": { + "description": "The list of metrics that are available for the cluster but disabled at the moment.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "enabledMetrics": { + "description": "The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.", + "type": "array", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "The provisioning state of the metrics configuration.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterMetricsConfigurationProvisioningState" + }, + "readOnly": true + } + } + }, + "ClusterPatchParameters": { + "type": "object", + "title": "ClusterPatchParameters represents the body of the request to patch the cluster properties.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity for the resource." + }, + "properties": { + "$ref": "#/definitions/ClusterPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterPatchProperties": { + "type": "object", + "title": "ClusterPatchProperties represents the properties of the cluster for patching.", + "properties": { + "aggregatorOrSingleRackDefinition": { + "$ref": "#/definitions/RackDefinition", + "description": "The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster." + }, + "clusterLocation": { + "description": "The customer-provided location information to identify where the cluster resides.", + "type": "string" + }, + "clusterServicePrincipal": { + "$ref": "#/definitions/ServicePrincipalInformation", + "description": "The service principal to be used by the cluster during Arc Appliance installation." + }, + "commandOutputSettings": { + "$ref": "#/definitions/CommandOutputSettings", + "description": "The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts." + }, + "computeDeploymentThreshold": { + "$ref": "#/definitions/ValidationThreshold", + "description": "The validation threshold indicating the allowable failures of compute machines during environment validation and deployment." + }, + "computeRackDefinitions": { + "description": "The list of rack definitions for the compute racks in a multi-rack\ncluster, or an empty list in a single-rack cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/RackDefinition" + }, + "x-ms-identifiers": [ + "networkRackId" + ] + }, + "runtimeProtectionConfiguration": { + "$ref": "#/definitions/RuntimeProtectionConfiguration", + "description": "The settings for cluster runtime protection." + }, + "secretArchive": { + "$ref": "#/definitions/ClusterSecretArchive", + "description": "The configuration for use of a key vault to store secrets for later retrieval by the operator." + }, + "updateStrategy": { + "$ref": "#/definitions/ClusterUpdateStrategy", + "description": "The strategy for updating the cluster." + } + } + }, + "ClusterProperties": { + "type": "object", + "title": "ClusterProperties represents the properties of a cluster.", + "required": [ + "networkFabricId", + "clusterType", + "clusterVersion", + "aggregatorOrSingleRackDefinition" + ], + "properties": { + "aggregatorOrSingleRackDefinition": { + "$ref": "#/definitions/RackDefinition", + "description": "The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster." + }, + "analyticsWorkspaceId": { + "description": "The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availableUpgradeVersions": { + "description": "The list of cluster runtime version upgrades available for this cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterAvailableUpgradeVersion" + }, + "x-ms-identifiers": [ + "targetClusterVersion" + ], + "readOnly": true + }, + "clusterCapacity": { + "$ref": "#/definitions/ClusterCapacity", + "description": "The capacity supported by this cluster.", + "readOnly": true + }, + "clusterConnectionStatus": { + "description": "The latest heartbeat status between the cluster manager and the cluster.", + "type": "string", + "enum": [ + "Connected", + "Disconnected", + "Timeout", + "Undefined" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterConnectionStatus" + }, + "readOnly": true + }, + "clusterExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.", + "readOnly": true + }, + "clusterLocation": { + "description": "The customer-provided location information to identify where the cluster resides.", + "type": "string", + "maxLength": 256 + }, + "clusterManagerConnectionStatus": { + "description": "The latest connectivity status between cluster manager and the cluster.", + "type": "string", + "enum": [ + "Connected", + "Unreachable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterManagerConnectionStatus" + }, + "readOnly": true + }, + "clusterManagerId": { + "description": "The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/clusterManagers" + } + ] + }, + "readOnly": true + }, + "clusterServicePrincipal": { + "$ref": "#/definitions/ServicePrincipalInformation", + "description": "The service principal to be used by the cluster during Arc Appliance installation." + }, + "clusterType": { + "description": "The type of rack configuration for the cluster.", + "type": "string", + "enum": [ + "SingleRack", + "MultiRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterVersion": { + "description": "The current runtime version of the cluster.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "commandOutputSettings": { + "$ref": "#/definitions/CommandOutputSettings", + "description": "The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts." + }, + "computeDeploymentThreshold": { + "$ref": "#/definitions/ValidationThreshold", + "description": "The validation threshold indicating the allowable failures of compute machines during environment validation and deployment." + }, + "computeRackDefinitions": { + "description": "The list of rack definitions for the compute racks in a multi-rack\ncluster, or an empty list in a single-rack cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/RackDefinition" + }, + "x-ms-identifiers": [ + "networkRackId" + ] + }, + "detailedStatus": { + "description": "The current detailed status of the cluster.", + "type": "string", + "enum": [ + "PendingDeployment", + "Deploying", + "Running", + "Updating", + "UpdatePaused", + "Degraded", + "Deleting", + "Disconnected", + "Failed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).", + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "The configuration of the managed resource group associated with the resource." + }, + "manualActionCount": { + "description": "The count of Manual Action Taken (MAT) events that have not been validated.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "networkFabricId": { + "description": "The resource ID of the Network Fabric associated with the cluster.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the cluster.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Validating", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterProvisioningState" + }, + "readOnly": true + }, + "runtimeProtectionConfiguration": { + "$ref": "#/definitions/RuntimeProtectionConfiguration", + "description": "The settings for cluster runtime protection." + }, + "secretArchive": { + "$ref": "#/definitions/ClusterSecretArchive", + "description": "The configuration for use of a key vault to store secrets for later retrieval by the operator." + }, + "supportExpiryDate": { + "description": "The support end date of the runtime version of the cluster.", + "type": "string", + "readOnly": true + }, + "updateStrategy": { + "$ref": "#/definitions/ClusterUpdateStrategy", + "description": "The strategy for updating the cluster." + }, + "workloadResourceIds": { + "description": "The list of workload resource IDs that are hosted within this cluster.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ClusterScanRuntimeParameters": { + "type": "object", + "title": "ClusterScanRuntimeParameters defines the parameters for the cluster scan runtime operation.", + "properties": { + "scanActivity": { + "description": "The choice of if the scan operation should run the scan.", + "type": "string", + "default": "Scan", + "enum": [ + "Scan", + "Skip" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterScanRuntimeParametersScanActivity" + } + } + } + }, + "ClusterSecretArchive": { + "type": "object", + "title": "ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval.", + "required": [ + "keyVaultId" + ], + "properties": { + "keyVaultId": { + "description": "The resource ID of the key vault to archive the secrets of the cluster.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "useKeyVault": { + "description": "The indicator if the specified key vault should be used to archive the secrets of the cluster.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterSecretArchiveEnabled" + } + } + } + }, + "ClusterUpdateStrategy": { + "type": "object", + "title": "ClusterUpdateStrategy represents the strategy for updating the cluster.", + "required": [ + "strategyType", + "thresholdType", + "thresholdValue" + ], + "properties": { + "maxUnavailable": { + "description": "The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack.\nLimited by the maximum number of machines in the increment. Defaults to the whole increment size.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "strategyType": { + "description": "The mode of operation for runtime protection.", + "type": "string", + "enum": [ + "Rack", + "PauseAfterRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterUpdateStrategyType" + } + }, + "thresholdType": { + "description": "Selection of how the threshold should be evaluated.", + "type": "string", + "enum": [ + "CountSuccess", + "PercentSuccess" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ValidationThresholdType" + } + }, + "thresholdValue": { + "description": "The numeric threshold value.", + "type": "integer", + "format": "int64", + "minimum": 0 + }, + "waitTimeMinutes": { + "description": "The time to wait between the increments of update defined by the strategy.", + "type": "integer", + "format": "int64", + "default": 15, + "maximum": 60, + "minimum": 0 + } + } + }, + "ClusterUpdateVersionParameters": { + "type": "object", + "title": "ClusterUpdateVersionParameters represents the body of the request to update cluster version.", + "required": [ + "targetClusterVersion" + ], + "properties": { + "targetClusterVersion": { + "description": "The version to be applied to the cluster during update.", + "type": "string" + } + } + }, + "CommandOutputSettings": { + "type": "object", + "title": "CommandOutputSettings represents the settings for commands run within the cluster such as bare metal machine run read-only commands.", + "properties": { + "associatedIdentity": { + "$ref": "#/definitions/IdentitySelector", + "description": "The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned." + }, + "containerUrl": { + "description": "The URL of the storage account container that is to be used by the specified identities.", + "type": "string", + "format": "uri" + } + } + }, + "Console": { + "type": "object", + "title": "Console represents the console of an on-premises Network Cloud virtual machine.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster manager associated with the cluster this virtual machine is created on." + }, + "properties": { + "$ref": "#/definitions/ConsoleProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "ConsoleList": { + "type": "object", + "title": "ConsoleList represents a list of virtual machine consoles.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of virtual machine consoles.", + "type": "array", + "items": { + "$ref": "#/definitions/Console" + } + } + } + }, + "ConsolePatchParameters": { + "type": "object", + "title": "ConsolePatchParameters represents the body of the request to patch the virtual machine console.", + "properties": { + "properties": { + "$ref": "#/definitions/ConsolePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConsolePatchProperties": { + "type": "object", + "title": "ConsolePatchProperties represents the properties of the virtual machine console that can be patched.", + "properties": { + "enabled": { + "description": "The indicator of whether the console access is enabled.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleEnabled" + } + }, + "expiration": { + "description": "The date and time after which the key will be disallowed access.", + "type": "string", + "format": "date-time" + }, + "sshPublicKey": { + "$ref": "#/definitions/SshPublicKey", + "description": "The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in." + } + } + }, + "ConsoleProperties": { + "type": "object", + "title": "ConsoleProperties represents the properties of the virtual machine console.", + "required": [ + "sshPublicKey", + "enabled" + ], + "properties": { + "detailedStatus": { + "description": "The more detailed status of the console.", + "type": "string", + "enum": [ + "Ready", + "Error" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "enabled": { + "description": "The indicator of whether the console access is enabled.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleEnabled" + } + }, + "expiration": { + "description": "The date and time after which the key will be disallowed access.", + "type": "string", + "format": "date-time" + }, + "privateLinkServiceId": { + "description": "The resource ID of the private link service that is used to provide virtual machine console access.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateLinkServices" + } + ] + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the virtual machine console.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConsoleProvisioningState" + }, + "readOnly": true + }, + "sshPublicKey": { + "$ref": "#/definitions/SshPublicKey", + "description": "The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in." + }, + "virtualMachineAccessId": { + "description": "The unique identifier for the virtual machine that is used to access the console.", + "type": "string", + "readOnly": true + } + } + }, + "ControlPlaneNodeConfiguration": { + "type": "object", + "title": "ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster.", + "required": [ + "count", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in the control plane.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "vmSkuName": { + "description": "The name of the VM SKU supplied during creation.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ControlPlaneNodePatchConfiguration": { + "type": "object", + "title": "ControlPlaneNodePatchConfiguration represents the properties of the control plane that can be patched for this Kubernetes cluster.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfigurationPatch", + "description": "The configuration of administrator credentials for the control plane nodes." + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "minimum": 1 + } + } + }, + "EgressEndpoint": { + "type": "object", + "title": "EgressEndpoint represents the connection from a cloud services network to the specified endpoint for a common purpose.", + "required": [ + "category", + "endpoints" + ], + "properties": { + "category": { + "description": "The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'.", + "type": "string" + }, + "endpoints": { + "description": "The list of endpoint dependencies.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDependency": { + "type": "object", + "title": "EndpointDependency represents the definition of an endpoint, including the domain and details.", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "port": { + "description": "The port of this endpoint.", + "type": "integer", + "format": "int64", + "maximum": 65535, + "minimum": 1 + } + } + }, + "ExtendedLocation": { + "type": "object", + "title": "ExtendedLocation represents the Azure custom location where the resource will be created.", + "required": [ + "type", + "name" + ], + "properties": { + "name": { + "description": "The resource ID of the extended location on which the resource will be created.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "type": { + "description": "The extended location type, for example, CustomLocation.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "FeatureStatus": { + "type": "object", + "title": "FeatureStatus contains information regarding a Kubernetes cluster feature.", + "properties": { + "detailedStatus": { + "description": "The status representing the state of this feature.", + "type": "string", + "enum": [ + "Running", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "FeatureDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the feature.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the feature.", + "type": "string", + "readOnly": true + } + } + }, + "HardwareInventory": { + "type": "object", + "title": "HardwareInventory represents the hardware configuration of this machine as exposed to the customer, including information acquired from the model/sku information and from the ironic inspector.", + "properties": { + "additionalHostInformation": { + "description": "Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration.", + "type": "string", + "readOnly": true + }, + "interfaces": { + "description": "The list of network interfaces and associated details for the bare metal machine.", + "type": "array", + "items": { + "$ref": "#/definitions/HardwareInventoryNetworkInterface" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "nics": { + "description": "Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine.", + "type": "array", + "items": { + "$ref": "#/definitions/Nic" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + } + }, + "HardwareInventoryNetworkInterface": { + "type": "object", + "title": "HardwareInventoryNetworkInterface represents the network interface details as part of a hardware inventory.", + "properties": { + "linkStatus": { + "description": "The current status of the link.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "The MAC address associated with this interface.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the interface.", + "type": "string", + "readOnly": true + }, + "networkInterfaceId": { + "description": "The resource ID of the network interface for the port on the switch that this machine's interface is connected to.", + "type": "string", + "readOnly": true + } + } + }, + "HardwareValidationStatus": { + "type": "object", + "title": "HardwareValidationStatus represents the latest hardware validation details performed for this bare metal machine.", + "properties": { + "lastValidationTime": { + "description": "The timestamp of the hardware validation execution.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "result": { + "description": "The outcome of the hardware validation.", + "type": "string", + "enum": [ + "Pass", + "Fail" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineHardwareValidationResult" + }, + "readOnly": true + } + } + }, + "IdentitySelector": { + "type": "object", + "title": "IdentitySelector represents the selection of a managed identity for use.", + "properties": { + "identityType": { + "description": "The type of managed identity that is being selected.", + "type": "string", + "enum": [ + "SystemAssignedIdentity", + "UserAssignedIdentity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedServiceIdentitySelectorType" + } + }, + "userAssignedIdentityResourceId": { + "description": "The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.", + "type": "string", + "format": "arm-id" + } + } + }, + "ImageRepositoryCredentials": { + "type": "object", + "title": "ImageRepositoryCredentials represents the credentials used to login to the image repository.", + "required": [ + "username", + "password", + "registryUrl" + ], + "properties": { + "password": { + "description": "The password or token used to access an image in the target repository.", + "type": "string", + "minLength": 1, + "x-ms-secret": true + }, + "registryUrl": { + "description": "The URL of the authentication server used to validate the repository credentials.", + "type": "string" + }, + "username": { + "description": "The username used to access an image in the target repository.", + "type": "string", + "minLength": 1 + } + } + }, + "InitialAgentPoolConfiguration": { + "type": "object", + "title": "InitialAgentPoolConfiguration specifies the configuration of a pool of virtual machines that are initially defined with a Kubernetes cluster.", + "required": [ + "count", + "mode", + "vmSkuName", + "name" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name that will be used for the agent pool resource representing this agent pool.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "IpAddressPool": { + "type": "object", + "title": "IpAddressPool represents a pool of IP addresses that can be allocated to a service.", + "required": [ + "addresses", + "name" + ], + "properties": { + "addresses": { + "description": "The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "autoAssign": { + "description": "The indicator to determine if automatic allocation from the pool should occur.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name used to identify this IP address pool for association with a BGP advertisement.", + "type": "string", + "pattern": "^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "onlyUseHostIps": { + "description": "The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "KeySetUser": { + "type": "object", + "title": "KeySetUser represents the properties of the user in the key set.", + "required": [ + "azureUserName", + "sshPublicKey" + ], + "properties": { + "azureUserName": { + "description": "The user name that will be used for access.", + "type": "string" + }, + "description": { + "description": "The free-form description for this user.", + "type": "string", + "maxLength": 256 + }, + "sshPublicKey": { + "$ref": "#/definitions/SshPublicKey", + "description": "The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in." + }, + "userPrincipalName": { + "description": "The user principal name (email format) used to validate this user's group membership.", + "type": "string" + } + } + }, + "KeySetUserStatus": { + "type": "object", + "title": "KeySetUserStatus represents the status of the key set user.", + "properties": { + "azureUserName": { + "description": "The user name that will be used for access.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The indicator of whether the user is currently deployed for access.", + "type": "string", + "enum": [ + "Active", + "Invalid" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineKeySetUserSetupStatus" + }, + "readOnly": true + }, + "statusMessage": { + "description": "The additional information describing the current status of this user, if any available.", + "type": "string", + "maxLength": 256, + "readOnly": true + } + } + }, + "KubernetesCluster": { + "type": "object", + "title": "KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/KubernetesClusterProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "KubernetesClusterFeature": { + "type": "object", + "title": "KubernetesClusterFeature represents the feature of a Kubernetes cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesClusterFeatureProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "KubernetesClusterFeatureList": { + "type": "object", + "title": "KubernetesClusterFeatureList represents the list of Kubernetes cluster feature resources.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of Kubernetes cluster features.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesClusterFeature" + } + } + } + }, + "KubernetesClusterFeaturePatchParameters": { + "type": "object", + "title": "KubernetesClusterFeaturePatchParameters represents the body of the request to patch the Kubernetes cluster feature.", + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesClusterFeaturePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "KubernetesClusterFeaturePatchProperties": { + "type": "object", + "title": "KubernetesClusterFeaturePatchProperties represents the Kubernetes cluster feature properties for patching.", + "properties": { + "options": { + "description": "The configured options for the feature.", + "type": "array", + "items": { + "$ref": "#/definitions/StringKeyValuePair" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "KubernetesClusterFeatureProperties": { + "type": "object", + "title": "KubernetesClusterFeatureProperties represents the properties of a Kubernetes cluster feature.", + "properties": { + "availabilityLifecycle": { + "description": "The lifecycle indicator of the feature.", + "type": "string", + "enum": [ + "Preview", + "GenerallyAvailable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureAvailabilityLifecycle" + }, + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed status of the feature.", + "type": "string", + "enum": [ + "Error", + "Provisioning", + "Installed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message for the detailed status of the feature.", + "type": "string", + "readOnly": true + }, + "options": { + "description": "The configured options for the feature.", + "type": "array", + "items": { + "$ref": "#/definitions/StringKeyValuePair" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "provisioningState": { + "description": "The provisioning state of the Kubernetes cluster feature.", + "type": "string", + "enum": [ + "Accepted", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureProvisioningState" + }, + "readOnly": true + }, + "required": { + "description": "The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterFeatureRequired" + }, + "readOnly": true + }, + "version": { + "description": "The version of the feature.", + "type": "string", + "readOnly": true + } + } + }, + "KubernetesClusterList": { + "type": "object", + "title": "KubernetesClusterList represents a list of Kubernetes clusters.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of additional details related to Kubernetes clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesCluster" + } + } + } + }, + "KubernetesClusterNode": { + "type": "object", + "title": "KubernetesClusterNode represents the details of a node in a Kubernetes cluster.", + "properties": { + "agentPoolId": { + "description": "The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools" + } + ] + }, + "readOnly": true + }, + "availabilityZone": { + "description": "The availability zone this node is running within.", + "type": "string", + "readOnly": true + }, + "bareMetalMachineId": { + "description": "The resource ID of the bare metal machine that hosts this node.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "cpuCores": { + "description": "The number of CPU cores configured for this node, derived from the VM SKU specified.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed state of this node.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning", + "Running", + "Scheduling", + "Stopped", + "Terminating", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterNodeDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "diskSizeGB": { + "description": "The size of the disk configured for this node. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "image": { + "description": "The machine image used to deploy this node.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The currently running version of Kubernetes and bundled features running on this node.", + "type": "string", + "readOnly": true + }, + "labels": { + "description": "The list of labels on this node that have been assigned to the agent pool containing this node.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-identifiers": [ + "key" + ], + "readOnly": true + }, + "memorySizeGB": { + "description": "The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "mode": { + "description": "The mode of the agent pool containing this node. Not applicable for control plane nodes.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "readOnly": true + }, + "name": { + "description": "The name of this node, as realized in the Kubernetes cluster.", + "type": "string", + "readOnly": true + }, + "networkAttachments": { + "description": "The NetworkAttachments made to this node.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAttachment" + }, + "x-ms-identifiers": [ + "networkAttachmentName" + ], + "readOnly": true + }, + "powerState": { + "description": "The power state of this node.", + "type": "string", + "enum": [ + "On", + "Off", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesNodePowerState" + }, + "readOnly": true + }, + "role": { + "description": "The role of this node in the cluster.", + "type": "string", + "enum": [ + "ControlPlane", + "Worker" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesNodeRole" + }, + "readOnly": true + }, + "taints": { + "description": "The list of taints that have been assigned to the agent pool containing this node.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-identifiers": [ + "key" + ], + "readOnly": true + }, + "vmSkuName": { + "description": "The VM SKU name that was used to create this cluster node.", + "type": "string", + "readOnly": true + } + } + }, + "KubernetesClusterPatchParameters": { + "type": "object", + "title": "KubernetesClusterPatchParameters represents the body of the request to patch the Hybrid AKS cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesClusterPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "KubernetesClusterPatchProperties": { + "type": "object", + "title": "KubernetesClusterPatchProperties represents the properties of the Kubernetes cluster that can be patched.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfigurationPatch", + "description": "The configuration of the default administrator credentials." + }, + "controlPlaneNodeConfiguration": { + "$ref": "#/definitions/ControlPlaneNodePatchConfiguration", + "description": "The defining characteristics of the control plane that can be patched for this Kubernetes cluster." + }, + "kubernetesVersion": { + "description": "The Kubernetes version for this cluster.", + "type": "string" + } + } + }, + "KubernetesClusterProperties": { + "type": "object", + "title": "KubernetesClusterProperties represents the properties of Kubernetes cluster resource.", + "required": [ + "initialAgentPoolConfigurations", + "controlPlaneNodeConfiguration", + "kubernetesVersion", + "networkConfiguration" + ], + "properties": { + "aadConfiguration": { + "$ref": "#/definitions/AadConfiguration", + "description": "The Azure Active Directory Integration properties.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values." + }, + "attachedNetworkIds": { + "description": "The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "availableUpgrades": { + "description": "The list of versions that this Kubernetes cluster can be upgraded to.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailableUpgrade" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "connectedClusterId": { + "description": "The resource ID of the connected cluster set up when this Kubernetes cluster is created.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Kubernetes/connectedClusters" + } + ] + }, + "readOnly": true + }, + "controlPlaneKubernetesVersion": { + "description": "The current running version of Kubernetes on the control plane.", + "type": "string", + "readOnly": true + }, + "controlPlaneNodeConfiguration": { + "$ref": "#/definitions/ControlPlaneNodeConfiguration", + "description": "The defining characteristics of the control plane for this Kubernetes Cluster." + }, + "detailedStatus": { + "description": "The current status of the Kubernetes cluster.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "featureStatuses": { + "description": "The current feature settings.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureStatus" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "initialAgentPoolConfigurations": { + "description": "The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/InitialAgentPoolConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "kubernetesVersion": { + "description": "The Kubernetes version for this cluster.", + "type": "string" + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "The configuration of the managed resource group associated with the resource." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nodes": { + "description": "The details of the nodes in this cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesClusterNode" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the Kubernetes cluster resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "InProgress", + "Created", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterProvisioningState" + }, + "readOnly": true + } + } + }, + "KubernetesClusterRestartNodeParameters": { + "type": "object", + "title": "KubernetesClusterRestartNodeParameters represents the body of the request to restart the node of a Kubernetes cluster.", + "required": [ + "nodeName" + ], + "properties": { + "nodeName": { + "description": "The name of the node to restart.", + "type": "string" + } + } + }, + "KubernetesLabel": { + "type": "object", + "title": "KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod.", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "description": "The name of the label or taint.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "value": { + "description": "The value of the label or taint.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L2Network": { + "type": "object", + "title": "L2Network represents a network that utilizes a single isolation domain set up for layer-2 resources.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/L2NetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "L2NetworkAttachmentConfiguration": { + "type": "object", + "title": "L2NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 2 network.", + "required": [ + "networkId" + ], + "properties": { + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/l2Networks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L2NetworkList": { + "type": "object", + "title": "L2NetworkList represents a list of L2 networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of L2 networks.", + "type": "array", + "items": { + "$ref": "#/definitions/L2Network" + } + } + } + }, + "L2NetworkPatchParameters": { + "type": "object", + "title": "L2NetworkPatchParameters represents the body of the request to patch the L2 network.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "L2NetworkProperties": { + "type": "object", + "title": "L2NetworkProperties represents properties of the L2 network.", + "required": [ + "l2IsolationDomainId" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this L2 network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the L2 network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L2NetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hybridAksPluginType": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "interfaceName": { + "description": "The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.", + "type": "string", + "maxLength": 12, + "pattern": "^[a-zA-Z0-9@._-]*$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l2IsolationDomainId": { + "description": "The resource ID of the Network Fabric l2IsolationDomain.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the L2 network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L2NetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "L2ServiceLoadBalancerConfiguration": { + "type": "object", + "title": "L2ServiceLoadBalancerConfiguration represents the configuration of a layer 2 service load balancer.", + "properties": { + "ipAddressPools": { + "description": "The list of pools of IP addresses that can be allocated to load balancer services.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressPool" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L3Network": { + "type": "object", + "title": "L3Network represents a network that utilizes a single isolation domain set up for layer-3 resources.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/L3NetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "L3NetworkAttachmentConfiguration": { + "type": "object", + "title": "L3NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 3 network.", + "required": [ + "networkId" + ], + "properties": { + "ipamEnabled": { + "description": "The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L3NetworkConfigurationIpamEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/l3Networks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "L3NetworkList": { + "type": "object", + "title": "L3NetworkList represents a list of L3 networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of L3 networks.", + "type": "array", + "items": { + "$ref": "#/definitions/L3Network" + } + } + } + }, + "L3NetworkPatchParameters": { + "type": "object", + "title": "L3NetworkPatchParameters represents the body of the request to patch the cloud services network.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "L3NetworkProperties": { + "type": "object", + "title": "L3NetworkProperties represents properties of the L3 network.", + "required": [ + "l3IsolationDomainId", + "vlan" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this L3 network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the L3 network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L3NetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hybridAksIpamEnabled": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksIpamEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hybridAksPluginType": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "interfaceName": { + "description": "The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.", + "type": "string", + "maxLength": 12, + "pattern": "^[a-zA-Z0-9@._-]*$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAllocationType": { + "description": "The type of the IP address allocation, defaulted to \"DualStack\".", + "type": "string", + "default": "DualStack", + "enum": [ + "IPV4", + "IPV6", + "DualStack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "IpAllocationType" + } + }, + "ipv4ConnectedPrefix": { + "description": "The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type\nis IPV4 or DualStack.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipv6ConnectedPrefix": { + "description": "The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type\nis IPV6 or DualStack.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l3IsolationDomainId": { + "description": "The resource ID of the Network Fabric l3IsolationDomain.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the L3 network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L3NetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vlan": { + "description": "The VLAN from the l3IsolationDomain that is used for this network.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "LldpNeighbor": { + "type": "object", + "title": "Type Deprecated. Will be removed in an upcoming version. LldpNeighbor represents the details about the device connected to the NIC.", + "properties": { + "portDescription": { + "description": "The descriptive information about the port on the connected device.", + "type": "string", + "readOnly": true + }, + "portName": { + "description": "The system-assigned name of the port on the connected device.", + "type": "string", + "readOnly": true + }, + "systemDescription": { + "description": "The descriptive information about the connected device.", + "type": "string", + "readOnly": true + }, + "systemName": { + "description": "The system-assigned name of the connected device.", + "type": "string", + "readOnly": true + } + } + }, + "MachineDisk": { + "type": "object", + "title": "Disk represents the properties of the disk.", + "properties": { + "capacityGB": { + "description": "The maximum amount of storage. Measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "connection": { + "description": "The connection type of the rack SKU resource.", + "type": "string", + "enum": [ + "PCIE", + "SATA", + "RAID", + "SAS" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "MachineSkuDiskConnectionType" + }, + "readOnly": true + }, + "type": { + "description": "The disk type of rack SKU resource.", + "type": "string", + "enum": [ + "HDD", + "SSD" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "DiskType" + }, + "readOnly": true + } + } + }, + "MachineSkuProperties": { + "type": "object", + "title": "MachineSkuProperties represents the properties of the machine SKU.", + "properties": { + "bootstrapProtocol": { + "description": "The type of bootstrap protocol used.", + "type": "string", + "enum": [ + "PXE" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BootstrapProtocol" + }, + "readOnly": true + }, + "cpuCores": { + "description": "The count of CPU cores for this machine.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "cpuSockets": { + "description": "The count of CPU sockets for this machine.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "disks": { + "description": "The list of disks.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineDisk" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "generation": { + "description": "The generation of the architecture.", + "type": "string", + "readOnly": true + }, + "hardwareVersion": { + "description": "The hardware version of the machine.", + "type": "string", + "readOnly": true + }, + "memoryCapacityGB": { + "description": "The maximum amount of memory. Measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "model": { + "description": "The model of the machine.", + "type": "string", + "readOnly": true + }, + "networkInterfaces": { + "description": "The list of network interfaces.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "totalThreads": { + "description": "The count of SMT and physical core threads for this machine.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "vendor": { + "description": "The make of the machine.", + "type": "string", + "readOnly": true + } + } + }, + "MachineSkuSlot": { + "type": "object", + "title": "MachineSkuSlot represents a single SKU and rack slot associated with the machine.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSkuProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "rackSlot": { + "description": "The position in the rack for the machine.", + "type": "integer", + "format": "int64", + "readOnly": true + } + } + }, + "ManagedResourceGroupConfiguration": { + "type": "object", + "title": "ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.", + "properties": { + "location": { + "description": "The location of the managed resource group. If not specified, the location of the parent resource is chosen.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name for the managed resource group. If not specified, the unique name is automatically generated.", + "type": "string", + "maxLength": 75, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "NetworkAttachment": { + "type": "object", + "title": "NetworkAttachment represents the single network attachment.", + "required": [ + "attachedNetworkId", + "ipAllocationMethod" + ], + "properties": { + "attachedNetworkId": { + "description": "The resource ID of the associated network attached to the virtual machine.\nIt can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "defaultGateway": { + "description": "The indicator of whether this is the default gateway.\nOnly one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.", + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "DefaultGateway" + } + }, + "ipAllocationMethod": { + "description": "The IP allocation mechanism for the virtual machine.\nDynamic and Static are only valid for l3Network which may also specify Disabled.\nOtherwise, Disabled is the only permitted value.", + "type": "string", + "enum": [ + "Dynamic", + "Static", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineIPAllocationMethod" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipv4Address": { + "description": "The IPv4 address of the virtual machine.\n\nThis field is used only if the attached network has IPAllocationType of IPV4 or DualStack.\n\nIf IPAllocationMethod is:\nStatic - this field must contain a user specified IPv4 address from within the subnet specified in the attached network.\nDynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network.\nDisabled - this field will be empty.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipv6Address": { + "description": "The IPv6 address of the virtual machine.\n\nThis field is used only if the attached network has IPAllocationType of IPV6 or DualStack.\n\nIf IPAllocationMethod is:\nStatic - this field must contain an IPv6 address range from within the range specified in the attached network.\nDynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network.\nDisabled - this field will be empty.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "macAddress": { + "description": "The MAC address of the interface for the virtual machine that corresponds to this network attachment.", + "type": "string", + "readOnly": true + }, + "networkAttachmentName": { + "description": "The associated network's interface name.\nIf specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine.\nIf the user doesn’t specify this value, the default interface name of the network resource will be used.\nFor a CloudServicesNetwork resource, this name will be ignored.", + "type": "string", + "maxLength": 15, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "NetworkConfiguration": { + "type": "object", + "title": "NetworkConfiguration specifies the Kubernetes cluster network related configuration.", + "required": [ + "cloudServicesNetworkId", + "cniNetworkId" + ], + "properties": { + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "$ref": "#/definitions/BgpServiceLoadBalancerConfiguration", + "description": "The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudServicesNetworkId": { + "description": "The resource ID of the associated Cloud Services network.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cniNetworkId": { + "description": "The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dnsServiceIp": { + "description": "The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l2ServiceLoadBalancerConfiguration": { + "$ref": "#/definitions/L2ServiceLoadBalancerConfiguration", + "description": "The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "podCidrs": { + "description": "The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "serviceCidrs": { + "description": "The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "NetworkInterface": { + "type": "object", + "title": "NetworkInterface represents properties of the network interface.", + "properties": { + "address": { + "description": "The partial address of Peripheral Component Interconnect (PCI).", + "type": "string", + "readOnly": true + }, + "deviceConnectionType": { + "description": "The connection type of the device.", + "type": "string", + "enum": [ + "PCI" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "DeviceConnectionType" + }, + "readOnly": true + }, + "model": { + "description": "The model name of the device.", + "type": "string", + "readOnly": true + }, + "physicalSlot": { + "description": "The physical slot for this device.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "portCount": { + "description": "The number of ports on the device.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "portSpeed": { + "description": "The maximum amount of data in gigabits that the line card transmits through a port at any given second.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "vendor": { + "description": "The vendor name of the device.", + "type": "string", + "readOnly": true + } + } + }, + "Nic": { + "type": "object", + "title": "Type Deprecated. Will be removed in an upcoming version. Nic represents the network interface card details.", + "properties": { + "lldpNeighbor": { + "$ref": "#/definitions/LldpNeighbor", + "description": "The information about the device connected to this NIC.", + "readOnly": true + }, + "macAddress": { + "description": "The MAC address associated with this NIC.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the NIC/interface.", + "type": "string", + "readOnly": true + } + } + }, + "NodePoolAdministratorConfigurationPatch": { + "type": "object", + "title": "NodePoolAdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.", + "properties": { + "sshPublicKeys": { + "description": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "keyData" + ] + } + } + }, + "OperationStatusResult": { + "type": "object", + "title": "The current status of an async operation.", + "required": [ + "status" + ], + "properties": { + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "If present, details of the operation error.", + "readOnly": true + }, + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the async operation.", + "type": "string", + "readOnly": true + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationStatusResult" + }, + "readOnly": true + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "maximum": 100, + "minimum": 0, + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationStatusResultProperties", + "description": "The additional properties of the operation status result.", + "x-ms-client-flatten": true + }, + "resourceId": { + "description": "Fully qualified ID of the resource against which the original async operation was started.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "Operation status.", + "type": "string" + } + } + }, + "OperationStatusResultProperties": { + "type": "object", + "title": "OperationStatusResultProperties represents additional properties of the operation status result.", + "properties": { + "exitCode": { + "description": "For actions that run commands or scripts, the exit code of the script execution.", + "type": "string", + "readOnly": true + }, + "outputHead": { + "description": "For actions that run commands or scripts, the leading bytes of the output of the script execution.", + "type": "string", + "readOnly": true + }, + "resultRef": { + "description": "For actions that run commands or scripts, a reference to the location of the result.", + "type": "string", + "format": "uri", + "readOnly": true + }, + "resultUrl": { + "description": "For actions that run commands or scripts, the URL where the full output of the script output can be retrieved.", + "type": "string", + "format": "uri", + "readOnly": true + } + } + }, + "OsDisk": { + "type": "object", + "title": "OsDisk represents configuration of the boot disk.", + "required": [ + "diskSizeGB" + ], + "properties": { + "createOption": { + "description": "The strategy for creating the OS disk.", + "type": "string", + "default": "Ephemeral", + "enum": [ + "Ephemeral" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OsDiskCreateOption" + } + }, + "deleteOption": { + "description": "The strategy for deleting the OS disk.", + "type": "string", + "default": "Delete", + "enum": [ + "Delete" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OsDiskDeleteOption" + } + }, + "diskSizeGB": { + "description": "The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64" + } + } + }, + "Rack": { + "type": "object", + "title": "Rack represents the hardware of the rack and is dependent upon the cluster for lifecycle.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/RackProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "RackDefinition": { + "type": "object", + "title": "RackDefinition represents details regarding the rack.", + "required": [ + "networkRackId", + "rackSkuId", + "rackSerialNumber" + ], + "properties": { + "availabilityZone": { + "description": "The zone name used for this rack when created. Availability zones are used for workload placement.", + "type": "string", + "pattern": "^[a-zA-Z0-9]{1,10}$" + }, + "bareMetalMachineConfigurationData": { + "description": "The unordered list of bare metal machine configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/BareMetalMachineConfigurationData" + }, + "x-ms-identifiers": [] + }, + "networkRackId": { + "description": "The resource ID of the network rack that matches this rack definition.", + "type": "string", + "format": "arm-id" + }, + "rackLocation": { + "description": "The free-form description of the rack's location.", + "type": "string", + "maxLength": 256 + }, + "rackSerialNumber": { + "description": "The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.", + "type": "string", + "maxLength": 64, + "minLength": 1 + }, + "rackSkuId": { + "description": "The resource ID of the sku for the rack being added.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/rackSkus" + } + ] + } + }, + "storageApplianceConfigurationData": { + "description": "The list of storage appliance configuration data for this rack.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageApplianceConfigurationData" + }, + "x-ms-identifiers": [] + } + } + }, + "RackList": { + "type": "object", + "title": "RackList represents a list of racks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of racks.", + "type": "array", + "items": { + "$ref": "#/definitions/Rack" + } + } + } + }, + "RackPatchParameters": { + "type": "object", + "title": "RackPatchParameters represents the body of the request to patch the rack properties.", + "properties": { + "properties": { + "$ref": "#/definitions/RacksPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "RackProperties": { + "type": "object", + "title": "RackProperties represents the properties of the rack.", + "required": [ + "rackSkuId", + "rackSerialNumber", + "availabilityZone", + "rackLocation" + ], + "properties": { + "availabilityZone": { + "description": "The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement.", + "type": "string", + "pattern": "^[a-zA-Z0-9]{1,10}$" + }, + "clusterId": { + "description": "The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the rack.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the rack resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackProvisioningState" + }, + "readOnly": true + }, + "rackLocation": { + "description": "The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”)", + "type": "string", + "maxLength": 256 + }, + "rackSerialNumber": { + "description": "The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.", + "type": "string", + "maxLength": 64, + "minLength": 1 + }, + "rackSkuId": { + "description": "The SKU for the rack.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/rackSkus" + } + ] + } + } + } + }, + "RackSku": { + "type": "object", + "title": "RackSku represents the SKU information of the rack.", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/RackSkuProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "x-ms-azure-resource": true + }, + "RackSkuList": { + "type": "object", + "title": "RackSkuList represents a list of rack SKUs.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of Rack SKUs.", + "type": "array", + "items": { + "$ref": "#/definitions/RackSku" + } + } + } + }, + "RackSkuProperties": { + "type": "object", + "title": "RackSkuProperties represents the properties of compute-related hardware for a rack. This supports both aggregator and compute racks.", + "properties": { + "computeMachines": { + "description": "The list of machine SKUs and associated rack slot for the compute-dedicated machines in this rack model.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineSkuSlot" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "controllerMachines": { + "description": "The list of machine SKUs and associated rack slot for the control-plane dedicated machines in this rack model.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineSkuSlot" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "description": { + "description": "The free-form text describing the rack.", + "type": "string", + "readOnly": true + }, + "maxClusterSlots": { + "description": "The maximum number of compute racks supported by an aggregator rack. 0 if this is a compute rack or a rack for a single rack cluster(rackType=\"Single\").", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the rack SKU resource.", + "type": "string", + "enum": [ + "Canceled", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackSkuProvisioningState" + }, + "readOnly": true + }, + "rackType": { + "description": "The type of the rack.", + "type": "string", + "enum": [ + "Aggregator", + "Compute", + "Single" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RackSkuType" + }, + "readOnly": true + }, + "storageAppliances": { + "description": "The list of appliance SKUs and associated rack slot for the storage appliance(s) in this rack model.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageApplianceSkuSlot" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "supportedRackSkuIds": { + "description": "The list of supported SKUs if the rack is an aggregator.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "RacksPatchProperties": { + "type": "object", + "title": "RacksPatchProperties represents the properties of the rack during patching.", + "properties": { + "rackLocation": { + "description": "The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”)", + "type": "string", + "maxLength": 256 + }, + "rackSerialNumber": { + "description": "The globally unique identifier for the rack.", + "type": "string", + "maxLength": 64, + "minLength": 1 + } + } + }, + "RuntimeProtectionConfiguration": { + "type": "object", + "title": "RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster.", + "properties": { + "enforcementLevel": { + "description": "The mode of operation for runtime protection.", + "type": "string", + "default": "Disabled", + "enum": [ + "Audit", + "Disabled", + "OnDemand", + "Passive", + "RealTime" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RuntimeProtectionEnforcementLevel" + } + } + } + }, + "RuntimeProtectionStatus": { + "type": "object", + "title": "RuntimeProtectionStatus represents the runtime protection status of the bare metal machine.", + "properties": { + "definitionsLastUpdated": { + "description": "The timestamp when the malware definitions were last updated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "definitionsVersion": { + "description": "The version of the malware definitions.", + "type": "string", + "readOnly": true + }, + "scanCompletedTime": { + "description": "The timestamp of the most recently completed scan, or empty if there has never been a scan.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scanScheduledTime": { + "description": "The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scanStartedTime": { + "description": "The timestamp of the most recently started scan, or empty if there has never been a scan.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "SecretArchiveReference": { + "type": "object", + "title": "SecretArchiveReference represents the reference to a secret in a key vault.", + "properties": { + "keyVaultId": { + "description": "The resource ID of the key vault containing the secret.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "readOnly": true + }, + "secretName": { + "description": "The name of the secret in the key vault.", + "type": "string", + "readOnly": true + }, + "secretVersion": { + "description": "The version of the secret in the key vault.", + "type": "string", + "readOnly": true + } + } + }, + "SecretRotationStatus": { + "type": "object", + "title": "SecretRotationStatus represents the status of a secret rotation.", + "properties": { + "expirePeriodDays": { + "description": "The maximum number of days the secret may be used before it must be changed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "lastRotationTime": { + "description": "The date and time when the secret was last changed.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "rotationPeriodDays": { + "description": "The number of days a secret exists before rotations will be attempted.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "secretArchiveReference": { + "$ref": "#/definitions/SecretArchiveReference", + "description": "The reference to the secret in a key vault.", + "readOnly": true + }, + "secretType": { + "description": "The type name used to identify the purpose of the secret.", + "type": "string", + "readOnly": true + } + } + }, + "ServiceLoadBalancerBgpPeer": { + "type": "object", + "title": "ServiceLoadBalancerBgpPeer represents the configuration of the BGP service load balancer for the Kubernetes cluster.", + "required": [ + "name", + "peerAddress", + "peerAsn" + ], + "properties": { + "bfdEnabled": { + "description": "The indicator of BFD enablement for this BgpPeer.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpMultiHop": { + "description": "The indicator to enable multi-hop peering support.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BgpMultiHop" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "holdTime": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keepAliveTime": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "myAsn": { + "description": "The autonomous system number used for the local end of the BGP session.", + "type": "integer", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name used to identify this BGP peer for association with a BGP advertisement.", + "type": "string", + "pattern": "^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "password": { + "description": "The authentication password for routers enforcing TCP MD5 authenticated sessions.", + "type": "string", + "maxLength": 80, + "pattern": "^[a-zA-Z0-9]{0,80}$", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "peerAddress": { + "description": "The IPv4 or IPv6 address used to connect this BGP session.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peerAsn": { + "description": "The autonomous system number expected from the remote end of the BGP session.", + "type": "integer", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peerPort": { + "description": "The port used to connect this BGP session.", + "type": "integer", + "format": "int64", + "default": 179, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ServicePrincipalInformation": { + "type": "object", + "title": "ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation.", + "required": [ + "tenantId", + "principalId", + "applicationId", + "password" + ], + "properties": { + "applicationId": { + "description": "The application ID, also known as client ID, of the service principal.", + "type": "string" + }, + "password": { + "description": "The password of the service principal.", + "type": "string", + "x-ms-secret": true + }, + "principalId": { + "description": "The principal ID, also known as the object ID, of the service principal.", + "type": "string" + }, + "tenantId": { + "description": "The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.", + "type": "string" + } + } + }, + "SshPublicKey": { + "type": "object", + "title": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", + "required": [ + "keyData" + ], + "properties": { + "keyData": { + "description": "The SSH public key data.", + "type": "string", + "minLength": 1 + } + } + }, + "StorageAppliance": { + "type": "object", + "title": "StorageAppliance represents on-premises Network Cloud storage appliance.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/StorageApplianceProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "StorageApplianceConfigurationData": { + "type": "object", + "title": "StorageApplianceConfigurationData represents configuration for the storage application.", + "required": [ + "rackSlot", + "adminCredentials", + "serialNumber" + ], + "properties": { + "adminCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the administrative interface on this storage appliance." + }, + "rackSlot": { + "description": "The slot that storage appliance is in the rack based on the BOM configuration.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1 + }, + "serialNumber": { + "description": "The serial number of the appliance.", + "type": "string" + }, + "storageApplianceName": { + "description": "The user-provided name for the storage appliance that will be created from this specification.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$" + } + } + }, + "StorageApplianceEnableRemoteVendorManagementParameters": { + "type": "object", + "title": "StorageApplianceEnableRemoteVendorManagementParameters represents the body of the request to enable remote vendor management of a storage appliance.", + "properties": { + "supportEndpoints": { + "description": "Field Deprecated. This field is not used and will be rejected if provided. The list of IPv4 subnets (in CIDR format), IPv6 subnets (in CIDR format), or hostnames that the storage appliance needs accessible in order to turn on the remote vendor management.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StorageApplianceList": { + "type": "object", + "title": "StorageApplianceList represents a list of storage appliances.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of storage appliances.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAppliance" + } + } + } + }, + "StorageAppliancePatchParameters": { + "type": "object", + "title": "StorageAppliancePatchParameters represents the body of the request to patch storage appliance properties.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageAppliancePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageAppliancePatchProperties": { + "type": "object", + "title": "StorageAppliancePatchProperties represents the properties of the storage appliance that can be patched.", + "properties": { + "serialNumber": { + "description": "The serial number for the storage appliance.", + "type": "string" + } + } + }, + "StorageApplianceProperties": { + "type": "object", + "title": "StorageApplianceProperties represents the properties of the storage appliance.", + "required": [ + "rackId", + "storageApplianceSkuId", + "rackSlot", + "serialNumber", + "administratorCredentials" + ], + "properties": { + "administratorCredentials": { + "$ref": "#/definitions/AdministrativeCredentials", + "description": "The credentials of the administrative interface on this storage appliance.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "capacity": { + "description": "The total capacity of the storage appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "capacityUsed": { + "description": "The amount of storage consumed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the cluster this storage appliance is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed status of the storage appliance.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "StorageApplianceDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "managementIpv4Address": { + "description": "The endpoint for the management interface of the storage appliance.", + "type": "string", + "readOnly": true + }, + "manufacturer": { + "description": "The manufacturer of the storage appliance.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "The model of the storage appliance.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the storage appliance.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "StorageApplianceProvisioningState" + }, + "readOnly": true + }, + "rackId": { + "description": "The resource ID of the rack where this storage appliance resides.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "rackSlot": { + "description": "The slot the storage appliance is in the rack based on the BOM configuration.", + "type": "integer", + "format": "int64", + "maximum": 256, + "minimum": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVendorManagementFeature": { + "description": "The indicator of whether the storage appliance supports remote vendor management.", + "type": "string", + "enum": [ + "Supported", + "Unsupported" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RemoteVendorManagementFeature" + }, + "readOnly": true + }, + "remoteVendorManagementStatus": { + "description": "The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature.", + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "Unsupported" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RemoteVendorManagementStatus" + }, + "readOnly": true + }, + "secretRotationStatus": { + "description": "The list of statuses that represent secret rotation activity.", + "type": "array", + "items": { + "$ref": "#/definitions/SecretRotationStatus" + }, + "x-ms-identifiers": [ + "secretType" + ], + "readOnly": true + }, + "serialNumber": { + "description": "The serial number for the storage appliance.", + "type": "string" + }, + "storageApplianceSkuId": { + "description": "The SKU for the storage appliance.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "version": { + "description": "The version of the storage appliance.", + "type": "string", + "readOnly": true + } + } + }, + "StorageApplianceSkuProperties": { + "type": "object", + "title": "StorageApplianceSkuProperties represents the properties of the storage appliance SKU.", + "properties": { + "capacityGB": { + "description": "The maximum capacity of the storage appliance. Measured in gibibytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "model": { + "description": "The model of the storage appliance.", + "type": "string", + "readOnly": true + } + } + }, + "StorageApplianceSkuSlot": { + "type": "object", + "title": "StorageApplianceSkuSlot represents the single SKU and rack slot associated with the storage appliance.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageApplianceSkuProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "rackSlot": { + "description": "The position in the rack for the storage appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + } + } + }, + "StorageProfile": { + "type": "object", + "title": "StorageProfile represents information about a disk.", + "required": [ + "osDisk" + ], + "properties": { + "osDisk": { + "$ref": "#/definitions/OsDisk", + "description": "The disk to use with this virtual machine." + }, + "volumeAttachments": { + "description": "The resource IDs of volumes that are requested to be attached to the virtual machine.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StringKeyValuePair": { + "type": "object", + "title": "StringKeyValuePair represents a single entry in a mapping of keys to values.", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "description": "The key to the mapped value.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "value": { + "description": "The value of the mapping key.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "TagsParameter": { + "type": "object", + "title": "TagsParameter represents the resource tags.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TrunkedNetwork": { + "type": "object", + "title": "TrunkedNetwork represents a network that utilizes multiple isolation domains and specified VLANs to create a trunked network.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/TrunkedNetworkProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "TrunkedNetworkAttachmentConfiguration": { + "type": "object", + "title": "TrunkedNetworkAttachmentConfiguration represents the configuration of the attachment of a trunked network.", + "required": [ + "networkId" + ], + "properties": { + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/trunkedNetworks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "TrunkedNetworkList": { + "type": "object", + "title": "TrunkedNetworkList represents a list of trunked networks.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of trunked networks.", + "type": "array", + "items": { + "$ref": "#/definitions/TrunkedNetwork" + } + } + } + }, + "TrunkedNetworkPatchParameters": { + "type": "object", + "title": "TrunkedNetworkPatchParameters represents the body of the request to patch the Trunked network.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TrunkedNetworkProperties": { + "type": "object", + "title": "TrunkedNetworkProperties represents properties of the trunked network.", + "required": [ + "isolationDomainIds", + "vlans" + ], + "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster this trunked network is associated with.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the trunked network.", + "type": "string", + "enum": [ + "Error", + "Available", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "TrunkedNetworkDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "hybridAksClustersAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hybridAksPluginType": { + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HybridAksPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "interfaceName": { + "description": "The default interface name for this trunked network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.", + "type": "string", + "maxLength": 12, + "pattern": "^[a-zA-Z0-9@._-]*$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isolationDomainIds": { + "description": "The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources.", + "type": "array", + "minItems": 1, + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the trunked network.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "TrunkedNetworkProvisioningState" + }, + "readOnly": true + }, + "virtualMachinesAssociatedIds": { + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this trunked network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vlans": { + "description": "The list of vlans that are selected from the isolation domains for trunking.", + "type": "array", + "minItems": 1, + "items": { + "type": "integer", + "format": "int64" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ValidationThreshold": { + "type": "object", + "title": "ValidationThreshold indicates allowed machine and node hardware and deployment failures.", + "required": [ + "type", + "grouping", + "value" + ], + "properties": { + "grouping": { + "description": "Selection of how the type evaluation is applied to the cluster calculation.", + "type": "string", + "enum": [ + "PerCluster", + "PerRack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ValidationThresholdGrouping" + } + }, + "type": { + "description": "Selection of how the threshold should be evaluated.", + "type": "string", + "enum": [ + "CountSuccess", + "PercentSuccess" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ValidationThresholdType" + } + }, + "value": { + "description": "The numeric threshold value.", + "type": "integer", + "format": "int64", + "minimum": 0 + } + } + }, + "VirtualMachine": { + "type": "object", + "title": "VirtualMachine represents the on-premises Network Cloud virtual machine.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "VirtualMachineList": { + "type": "object", + "title": "VirtualMachineList represents a list of virtual machines.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of virtual machines.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + } + } + } + }, + "VirtualMachinePatchParameters": { + "type": "object", + "title": "VirtualMachinePatchParameters represents the body of the request to patch the virtual machine.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachinePatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualMachinePatchProperties": { + "type": "object", + "title": "VirtualMachinePatchProperties represents the properties of the virtual machine that can be patched.", + "properties": { + "vmImageRepositoryCredentials": { + "$ref": "#/definitions/ImageRepositoryCredentials", + "description": "The credentials used to login to the image repository that has access to the specified image." + } + } + }, + "VirtualMachinePlacementHint": { + "type": "object", + "title": "VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine.", + "required": [ + "hintType", + "schedulingExecution", + "resourceId", + "scope" + ], + "properties": { + "hintType": { + "description": "The specification of whether this hint supports affinity or anti-affinity with the referenced resources.", + "type": "string", + "enum": [ + "Affinity", + "AntiAffinity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachinePlacementHintType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "resourceId": { + "description": "The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "schedulingExecution": { + "description": "The indicator of whether the hint is a hard or soft requirement during scheduling.", + "type": "string", + "enum": [ + "Hard", + "Soft" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineSchedulingExecution" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scope": { + "description": "The scope for the virtual machine affinity or anti-affinity placement hint. It should always be \"Machine\" in the case of node affinity.", + "type": "string", + "enum": [ + "Rack", + "Machine" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachinePlacementHintPodAffinityScope" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "VirtualMachinePowerOffParameters": { + "type": "object", + "title": "VirtualMachinePowerOffParameters represents the body of the request to power off virtual machine.", + "properties": { + "skipShutdown": { + "description": "The indicator of whether to skip the graceful OS shutdown and power off the virtual machine immediately.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "SkipShutdown" + } + } + } + }, + "VirtualMachineProperties": { + "type": "object", + "title": "VirtualMachineProperties represents the properties of the virtual machine.", + "required": [ + "vmImage", + "cpuCores", + "memorySizeGB", + "storageProfile", + "cloudServicesNetworkAttachment", + "adminUsername" + ], + "properties": { + "adminUsername": { + "description": "The name of the administrator to which the ssh public keys will be added into the authorized keys.", + "type": "string", + "maxLength": 32, + "minLength": 1, + "pattern": "^[a-z_][a-z0-9_]{0,31}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZone": { + "description": "The cluster availability zone containing this virtual machine.", + "type": "string", + "readOnly": true + }, + "bareMetalMachineId": { + "description": "The resource ID of the bare metal machine that hosts the virtual machine.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "bootMethod": { + "description": "Selects the boot method for the virtual machine.", + "type": "string", + "default": "UEFI", + "enum": [ + "UEFI", + "BIOS" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineBootMethod" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudServicesNetworkAttachment": { + "$ref": "#/definitions/NetworkAttachment", + "description": "The cloud service network that provides platform-level services for the virtual machine.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterId": { + "description": "The resource ID of the cluster the virtual machine is created for.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "cpuCores": { + "description": "The number of CPU cores in the virtual machine.", + "type": "integer", + "format": "int64", + "minimum": 2, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "detailedStatus": { + "description": "The more detailed status of the virtual machine.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning", + "Running", + "Scheduling", + "Stopped", + "Terminating", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "isolateEmulatorThread": { + "description": "Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineIsolateEmulatorThread" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "memorySizeGB": { + "description": "The memory size of the virtual machine. Allocations are measured in gibibytes.", + "type": "integer", + "format": "int64", + "minimum": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkAttachments": { + "description": "The list of network attachments to the virtual machine.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAttachment" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkData": { + "description": "The Base64 encoded cloud-init network data.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "placementHints": { + "description": "The scheduling hints for the virtual machine.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachinePlacementHint" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "powerState": { + "description": "The power state of the virtual machine.", + "type": "string", + "enum": [ + "On", + "Off", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachinePowerState" + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the virtual machine.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineProvisioningState" + }, + "readOnly": true + }, + "sshPublicKeys": { + "description": "The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile that specifies size and other parameters about the disks related to the virtual machine.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "userData": { + "description": "The Base64 encoded cloud-init user data.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "virtioInterface": { + "description": "Field Deprecated, use virtualizationModel instead. The type of the virtio interface.", + "type": "string", + "default": "Modern", + "enum": [ + "Modern", + "Transitional" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineVirtioInterfaceType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmDeviceModel": { + "description": "The type of the device model to use.", + "type": "string", + "default": "T2", + "enum": [ + "T1", + "T2" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VirtualMachineDeviceModelType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmImage": { + "description": "The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmImageRepositoryCredentials": { + "$ref": "#/definitions/ImageRepositoryCredentials", + "description": "The credentials used to login to the image repository that has access to the specified image." + }, + "volumes": { + "description": "The resource IDs of volumes that are attached to the virtual machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "Volume": { + "type": "object", + "title": "Volume represents storage made available for use by resources running on the cluster.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/VolumeProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "VolumeList": { + "type": "object", + "title": "VolumeList represents a list of volumes.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of volumes.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + } + } + } + }, + "VolumePatchParameters": { + "type": "object", + "title": "VolumePatchParameters represents the body of the request to patch the volume resource.", + "properties": { + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VolumeProperties": { + "type": "object", + "title": "VolumeProperties represents properties of the volume resource.", + "required": [ + "sizeMiB" + ], + "properties": { + "attachedTo": { + "description": "The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "detailedStatus": { + "description": "The more detailed status of the volume.", + "type": "string", + "enum": [ + "Error", + "Active", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VolumeDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the volume.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Accepted" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "VolumeProvisioningState" + }, + "readOnly": true + }, + "serialNumber": { + "description": "The unique identifier of the volume.", + "type": "string", + "readOnly": true + }, + "sizeMiB": { + "description": "The size of the allocation for this volume in Mebibytes.", + "type": "integer", + "format": "int64", + "minimum": 1, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + } + }, + "parameters": { + "AgentPoolNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the Kubernetes cluster agent pool.", + "name": "agentPoolName", + "in": "path", + "required": true + }, + "BareMetalMachineKeySetNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the bare metal machine key set.", + "name": "bareMetalMachineKeySetName", + "in": "path", + "required": true + }, + "BareMetalMachineNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the bare metal machine.", + "name": "bareMetalMachineName", + "in": "path", + "required": true + }, + "BmcKeySetNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the baseboard management controller key set.", + "name": "bmcKeySetName", + "in": "path", + "required": true + }, + "CloudServicesNetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the cloud services network.", + "name": "cloudServicesNetworkName", + "in": "path", + "required": true + }, + "ClusterManagerNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the cluster manager.", + "name": "clusterManagerName", + "in": "path", + "required": true + }, + "ClusterNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the cluster.", + "name": "clusterName", + "in": "path", + "required": true + }, + "ConsoleNameParameter": { + "pattern": "^default$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the virtual machine console.", + "name": "consoleName", + "in": "path", + "required": true + }, + "FeatureNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the feature.", + "name": "featureName", + "in": "path", + "required": true + }, + "KubernetesClusterNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the Kubernetes cluster.", + "name": "kubernetesClusterName", + "in": "path", + "required": true + }, + "L2NetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the L2 network.", + "name": "l2NetworkName", + "in": "path", + "required": true + }, + "L3NetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the L3 network.", + "name": "l3NetworkName", + "in": "path", + "required": true + }, + "MetricsConfigurationName": { + "pattern": "^default$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the metrics configuration for the cluster.", + "name": "metricsConfigurationName", + "in": "path", + "required": true + }, + "RackNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the rack.", + "name": "rackName", + "in": "path", + "required": true + }, + "RackSkuNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the rack SKU.", + "name": "rackSkuName", + "in": "path", + "required": true + }, + "StorageApplianceNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the storage appliance.", + "name": "storageApplianceName", + "in": "path", + "required": true + }, + "TrunkedNetworkNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the trunked network.", + "name": "trunkedNetworkName", + "in": "path", + "required": true + }, + "VirtualMachineNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the virtual machine.", + "name": "virtualMachineName", + "in": "path", + "required": true + }, + "VolumeNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,62}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the volume.", + "name": "volumeName", + "in": "path", + "required": true + } + }, + "securityDefinitions": { + "azure_auth": { + "description": "Azure Active Directory OAuth2 Flow.", + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/networkcloud/resource-manager/readme.md b/specification/networkcloud/resource-manager/readme.md index dcf5e9431dda..9f894133362c 100644 --- a/specification/networkcloud/resource-manager/readme.md +++ b/specification/networkcloud/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for NetworkCloud. ```yaml openapi-type: arm openapi-subtype: providerHub -tag: package-2023-10-01-preview +tag: package-2024-06-01-preview ``` --- @@ -50,6 +50,31 @@ input-file: - Microsoft.NetworkCloud/preview/2023-10-01-preview/networkcloud.json ``` +### Tag: package-2024-06-01-preview + +These settings apply only when `--tag=package-2024-06-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-01-preview' +input-file: + - Microsoft.NetworkCloud/preview/2024-06-01-preview/networkcloud.json +suppressions: + - code: PatchBodyParametersSchema + from: networkcloud.json + reason: False positive based on Azure common types. Managed Service Identity requires type, and the Managed Service Identity can be patched. + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}"].patch.parameters[4].schema.properties.identity + - code: PatchBodyParametersSchema + from: networkcloud.json + reason: False positive based on Azure common types. Managed Service Identity requires type, and the Managed Service Identity can be patched. + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}"].patch.parameters[4].schema.properties.identity + - code: PatchBodyParametersSchema + from: networkcloud.json + reason: Nested objects that share a structure with PUT have required fields. The required field is present in the patch structure as well, because it reuses types. The nested structure needs to be updated in full by the user. + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}"].patch.parameters[4].schema.properties.properties + - code: BodyTopLevelProperties + from: networkcloud.json + reason: Bug in Linter, see https://github.com/Azure/azure-openapi-validator/issues/722 +``` + --- # Code Generation diff --git a/specification/networkcloud/resource-manager/sdk-suppressions.yaml b/specification/networkcloud/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..201cf839be1f --- /dev/null +++ b/specification/networkcloud/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,5 @@ +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-networkcloud + breaking-changes: + - The class 'AgentPoolUpgradeSettings' method '__init__' had its parameter 'max_surge' default value changed from 'str' to 'none' From a0d769a54466cd6854365084e401ce7d2dea0f46 Mon Sep 17 00:00:00 2001 From: pednekarpraj <72415888+pednekarpraj@users.noreply.github.com> Date: Tue, 27 Aug 2024 09:27:40 -0700 Subject: [PATCH 13/30] Support 1 month reservation term (#30151) * Added tag for 2024-08-01 in readme file * Copy files from stable/2023-11-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-08-01 Updated the API version from stable/2023-11-01 to stable/2024-08-01. * Added tag for 2024-08-01 in readme file * Support 1 month reservation term * Fix check errors * Fix prettier warnings * Fix readme.md * add sdk-suppressions.yaml * add directive for js as it's added for go in 23914 * Update sdk-suppressions.yaml * Update sdk-suppressions.yaml --------- Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Yuchao Yan --- .../stable/2024-08-01/consumption.json | 6127 +++++++++++++++++ .../2024-08-01/consumption_pricesheet.json | 158 + .../AggregatedCostByManagementGroup.json | 47 + ...atedCostByManagementGroupFilterByDate.json | 48 + ...CostForBillingPeriodByManagementGroup.json | 40 + .../examples/BalancesByBillingAccount.json | 47 + ...ancesByBillingAccountForBillingPeriod.json | 48 + .../stable/2024-08-01/examples/Budget.json | 85 + .../2024-08-01/examples/BudgetsList.json | 186 + .../ChargesForBillingPeriodByDepartment.json | 30 + ...esForBillingPeriodByEnrollmentAccount.json | 30 + .../ChargesListByModernBillingAccount.json | 43 + ...BillingAccountGroupByBillingProfileId.json | 68 + ...ModernBillingAccountGroupByCustomerId.json | 73 + ...BillingAccountGroupByInvoiceSectionId.json | 71 + .../ChargesListByModernBillingProfile.json | 41 + ...BillingProfileGroupByInvoiceSectionId.json | 71 + ...tByModernBillingProfileInvoiceSection.json | 70 + .../examples/ChargesListByModernCustomer.json | 41 + .../ChargesListByModernInvoiceSectionId.json | 41 + ...ListForDepartmentFilterByStartEndDate.json | 30 + ...EnrollmentAccountFilterByStartEndDate.json | 29 + .../examples/CreateOrUpdateBudget.json | 227 + .../CreditSummaryByBillingProfile.json | 48 + .../2024-08-01/examples/DeleteBudget.json | 12 + .../EAPriceSheetForBillingPeriod.json | 24 + ...EventsGetByBillingAccount-Contributor.json | 56 + .../EventsGetByBillingAccount-Primary.json | 68 + .../examples/EventsGetByBillingAccount.json | 66 + ...BillingAccountWithFilters-Contributor.json | 34 + ...etByBillingAccountWithFilters-Primary.json | 40 + .../EventsGetByBillingAccountWithFilters.json | 40 + .../examples/EventsListByBillingProfile.json | 261 + .../LotsListByBillingAccount-Contributor.json | 31 + .../LotsListByBillingAccount-Primary.json | 39 + .../examples/LotsListByBillingAccount.json | 54 + ...BillingAccountWithFilters-Contributor.json | 32 + ...stByBillingAccountWithFilters-Primary.json | 40 + .../LotsListByBillingAccountWithFilters.json | 35 + .../examples/LotsListByBillingProfile.json | 83 + .../examples/LotsListByCustomer.json | 55 + .../LotsListByCustomerWithFilters.json | 36 + .../MarketplacesByBillingAccountList.json | 50 + ...sByBillingAccountListForBillingPeriod.json | 52 + .../MarketplacesByDepartmentList.json | 52 + ...lacesByDepartment_ListByBillingPeriod.json | 52 + .../MarketplacesByEnrollmentAccountList.json | 52 + ...nrollmentAccounts_ListByBillingPeriod.json | 52 + .../MarketplacesByManagementGroupList.json | 86 + ...yManagementGroup_ListForBillingPeriod.json | 87 + .../2024-08-01/examples/MarketplacesList.json | 50 + .../MarketplacesListForBillingPeriod.json | 52 + .../2024-08-01/examples/OperationList.json | 293 + .../2024-08-01/examples/PriceSheet.json | 35 + .../2024-08-01/examples/PriceSheetExpand.json | 40 + .../examples/PriceSheetForBillingPeriod.json | 31 + .../examples/ReservationDetails.json | 36 + .../ReservationDetailsByBillingAccountId.json | 33 + .../ReservationDetailsByBillingProfileId.json | 34 + ...etailsByBillingProfileIdReservationId.json | 36 + .../ReservationDetailsWithReservationId.json | 38 + ...RecommendationDetailsByBillingAccount.json | 105 + ...RecommendationDetailsByBillingProfile.json | 72 + ...nRecommendationDetailsByResourceGroup.json | 76 + ...onRecommendationDetailsBySubscription.json | 75 + ...vationRecommendationsByBillingAccount.json | 86 + ...ndationsByBillingAccountFilterByScope.json | 68 + ...vationRecommendationsByBillingProfile.json | 90 + ...rvationRecommendationsByResourceGroup.json | 60 + ...ervationRecommendationsBySubscription.json | 60 + ...rBySubscriptionForScopeLookBackPeriod.json | 81 + .../examples/ReservationSummariesDaily.json | 42 + ...ionSummariesDailyWithBillingAccountId.json | 33 + ...ionSummariesDailyWithBillingProfileId.json | 34 + ...vationSummariesDailyWithReservationId.json | 43 + .../examples/ReservationSummariesMonthly.json | 41 + ...nSummariesMonthlyWithBillingAccountId.json | 32 + ...nSummariesMonthlyWithBillingProfileId.json | 32 + ...thlyWithBillingProfileIdReservationId.json | 34 + ...tionSummariesMonthlyWithReservationId.json | 42 + ...ionTransactionsListByBillingProfileId.json | 43 + ...ionTransactionsListByEnrollmentNumber.json | 79 + .../stable/2024-08-01/examples/Tags.json | 51 + .../examples/UsageDetailsExpand.json | 70 + .../2024-08-01/examples/UsageDetailsList.json | 60 + .../UsageDetailsListByBillingAccount.json | 59 + .../UsageDetailsListByDepartment.json | 59 + .../UsageDetailsListByEnrollmentAccount.json | 59 + .../UsageDetailsListByMCABillingAccount.json | 88 + .../UsageDetailsListByMCABillingProfile.json | 88 + .../UsageDetailsListByMCACustomer.json | 88 + .../UsageDetailsListByMCAInvoiceSection.json | 88 + .../UsageDetailsListByManagementGroup.json | 103 + .../UsageDetailsListByMetricActualCost.json | 60 + ...UsageDetailsListByMetricAmortizedCost.json | 61 + .../UsageDetailsListByMetricUsage.json | 60 + .../examples/UsageDetailsListFilterByTag.json | 59 + .../UsageDetailsListForBillingPeriod.json | 59 + ...sListForBillingPeriodByBillingAccount.json | 59 + ...tailsListForBillingPeriodByDepartment.json | 59 + ...stForBillingPeriodByEnrollmentAccount.json | 59 + ...ListForBillingPeriodByManagementGroup.json | 103 + .../consumption/resource-manager/readme.md | 11 +- .../resource-manager/readme.typescript.md | 6 + .../resource-manager/sdk-suppressions.yaml | 93 + 105 files changed, 12595 insertions(+), 1 deletion(-) create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption_pricesheet.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroup.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroupFilterByDate.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccountForBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Budget.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BudgetsList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByDepartment.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByEnrollmentAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByBillingProfileId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByCustomerId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByInvoiceSectionId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfile.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileGroupByInvoiceSectionId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileInvoiceSection.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernCustomer.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernInvoiceSectionId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForDepartmentFilterByStartEndDate.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreateOrUpdateBudget.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreditSummaryByBillingProfile.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/DeleteBudget.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EAPriceSheetForBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Contributor.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Primary.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Contributor.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Primary.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsListByBillingProfile.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Contributor.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Primary.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Contributor.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Primary.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingProfile.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomer.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomerWithFilters.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountListForBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartmentList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartment_ListByBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccountList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroupList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesListForBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/OperationList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheet.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetExpand.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetForBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetails.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingAccountId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileIdReservationId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsWithReservationId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingProfile.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByResourceGroup.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsBySubscription.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccountFilterByScope.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingProfile.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByResourceGroup.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsBySubscription.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDaily.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingAccountId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingProfileId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithReservationId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthly.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithReservationId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByBillingProfileId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByEnrollmentNumber.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Tags.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsExpand.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByDepartment.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByEnrollmentAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingProfile.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCACustomer.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCAInvoiceSection.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByManagementGroup.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricActualCost.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricAmortizedCost.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricUsage.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListFilterByTag.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriod.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByBillingAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByDepartment.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByManagementGroup.json create mode 100644 specification/consumption/resource-manager/sdk-suppressions.yaml diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption.json new file mode 100644 index 000000000000..d72d22697aa5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption.json @@ -0,0 +1,6127 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-01", + "title": "ConsumptionManagementClient", + "description": "Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions." + }, + "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": { + "/{scope}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_List", + "description": "Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.\n\n**Note:Microsoft will be retiring the Consumption Usage Details API at some point in the future. We do not recommend that you take a new dependency on this API. Please use the Cost Details API instead. We will notify customers once a date for retirement has been determined.For Learn more,see [Generate Cost Details Report - Create Operation](https://learn.microsoft.com/en-us/rest/api/cost-management/generate-cost-details-report/create-operation?tabs=HTTP)**", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList-Legacy": { + "$ref": "./examples/UsageDetailsList.json" + }, + "UsageDetailsListFilterByTag-Legacy": { + "$ref": "./examples/UsageDetailsListFilterByTag.json" + }, + "UsageDetailsListForBillingPeriod-Legacy": { + "$ref": "./examples/UsageDetailsListForBillingPeriod.json" + }, + "UsageDetailsExpand-Legacy": { + "$ref": "./examples/UsageDetailsExpand.json" + }, + "UsageDetailsListByMetricActualCost-Legacy": { + "$ref": "./examples/UsageDetailsListByMetricActualCost.json" + }, + "UsageDetailsListByMetricAmortizedCost-Legacy": { + "$ref": "./examples/UsageDetailsListByMetricAmortizedCost.json" + }, + "UsageDetailsListByMetricUsage-Legacy": { + "$ref": "./examples/UsageDetailsListByMetricUsage.json" + }, + "BillingAccountUsageDetailsList-Legacy": { + "$ref": "./examples/UsageDetailsListByBillingAccount.json" + }, + "BillingAccountUsageDetailsListForBillingPeriod-Legacy": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByBillingAccount.json" + }, + "DepartmentUsageDetailsList-Legacy": { + "$ref": "./examples/UsageDetailsListByDepartment.json" + }, + "DepartmentUsageDetailsListForBillingPeriod-Legacy": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByDepartment.json" + }, + "EnrollmentAccountUsageDetailsList-Legacy": { + "$ref": "./examples/UsageDetailsListByEnrollmentAccount.json" + }, + "EnrollmentAccountUsageDetailsListForBillingPeriod-Legacy": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json" + }, + "ManagementGroupUsageDetailsList-Legacy": { + "$ref": "./examples/UsageDetailsListByManagementGroup.json" + }, + "ManagementGroupUsageDetailsListForBillingPeriod-Legacy": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByManagementGroup.json" + }, + "BillingAccountUsageDetailsList-Modern": { + "$ref": "./examples/UsageDetailsListByMCABillingAccount.json" + }, + "BillingProfileUsageDetailsList-Modern": { + "$ref": "./examples/UsageDetailsListByMCABillingProfile.json" + }, + "InvoiceSectionUsageDetailsList-Modern": { + "$ref": "./examples/UsageDetailsListByMCAInvoiceSection.json" + }, + "CustomerUsageDetailsList-Modern": { + "$ref": "./examples/UsageDetailsListByMCACustomer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalInfo or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/metricParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "204": { + "description": "No Content. The request has succeeded but returned no results." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_List", + "description": "Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "SubscriptionMarketplacesList": { + "$ref": "./examples/MarketplacesList.json" + }, + "SubscriptionMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesListForBillingPeriod.json" + }, + "BillingAccountMarketplacesList": { + "$ref": "./examples/MarketplacesByBillingAccountList.json" + }, + "BillingAccountMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByBillingAccountListForBillingPeriod.json" + }, + "DepartmentMarketplacesList": { + "$ref": "./examples/MarketplacesByDepartmentList.json" + }, + "DepartmentMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByDepartment_ListByBillingPeriod.json" + }, + "EnrollmentAccountMarketplacesList": { + "$ref": "./examples/MarketplacesByEnrollmentAccountList.json" + }, + "EnrollmentAccountMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json" + }, + "ManagementGroupMarketplacesList": { + "$ref": "./examples/MarketplacesByManagementGroupList.json" + }, + "ManagementGroupMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByManagementGroup_ListForBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/scopeMarketplaceParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "204": { + "description": "An empty response is sent when there is no information available within the selected scope." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Consumption/budgets": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_List", + "description": "Lists all budgets for the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "BudgetsList": { + "$ref": "./examples/BudgetsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BudgetsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Get", + "description": "Gets the budget for the scope by budget name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Budget": { + "$ref": "./examples/Budget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_CreateOrUpdate", + "description": "The operation to create or update a budget. You can optionally provide an eTag if desired as a form of concurrency control. To obtain the latest eTag for a given budget, perform a get operation prior to your put operation.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CreateOrUpdateBudget": { + "$ref": "./examples/CreateOrUpdateBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Budget" + }, + "description": "Parameters supplied to the Create Budget operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Delete", + "description": "The operation to delete a budget.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "DeleteBudget": { + "$ref": "./examples/DeleteBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Consumption/tags": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_Get", + "description": "Get all available tag keys for the defined scope", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Tags_Get": { + "$ref": "./examples/Tags.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeTagsParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagsResult" + } + }, + "204": { + "description": "An empty response is sent when there is no information available within the selected scope." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Consumption/charges": { + "get": { + "tags": [ + "Charges" + ], + "operationId": "Charges_List", + "description": "Lists the charges based for the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ChargesListForEnrollmentAccount-Legacy": { + "$ref": "./examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json" + }, + "ChangesForBillingPeriodByEnrollmentAccount-Legacy": { + "$ref": "./examples/ChargesForBillingPeriodByEnrollmentAccount.json" + }, + "ChargesListByDepartment-Legacy": { + "$ref": "./examples/ChargesListForDepartmentFilterByStartEndDate.json" + }, + "ChangesForBillingPeriodByDepartment-Legacy": { + "$ref": "./examples/ChargesForBillingPeriodByDepartment.json" + }, + "ChargesListByBillingAccount-Modern": { + "$ref": "./examples/ChargesListByModernBillingAccount.json" + }, + "ChargesListByBillingAccountGroupByBillingProfileId-Modern": { + "$ref": "./examples/ChargesListByModernBillingAccountGroupByBillingProfileId.json" + }, + "ChargesListByBillingAccountGroupByInvoiceSectionId-Modern": { + "$ref": "./examples/ChargesListByModernBillingAccountGroupByInvoiceSectionId.json" + }, + "ChargesListByBillingAccountGroupByCustomerId-Modern": { + "$ref": "./examples/ChargesListByModernBillingAccountGroupByCustomerId.json" + }, + "ChargesListByBillingProfile-Modern": { + "$ref": "./examples/ChargesListByModernBillingProfile.json" + }, + "ChargesListByBillingProfileInvoiceSection-Modern": { + "$ref": "./examples/ChargesListByModernBillingProfileInvoiceSection.json" + }, + "ChargesListByBillingProfileGroupByInvoiceSectionId-Modern": { + "$ref": "./examples/ChargesListByModernBillingProfileGroupByInvoiceSectionId.json" + }, + "ChargesListByInvoiceSectionId-Modern": { + "$ref": "./examples/ChargesListByModernInvoiceSectionId.json" + }, + "ChargesListByCustomer-Modern": { + "$ref": "./examples/ChargesListByModernCustomer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeChargesParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "startDate", + "in": "query", + "description": "Start date", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "endDate", + "in": "query", + "description": "End date", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "$filter", + "description": "May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "May be used to group charges for billingAccount scope by properties/billingProfileId, properties/invoiceSectionId, properties/customerId (specific for Partner Led), or for billingProfile scope by properties/invoiceSectionId.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ChargesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances": { + "get": { + "tags": [ + "Balances" + ], + "operationId": "Balances_GetByBillingAccount", + "description": "Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Balances": { + "$ref": "./examples/BalancesByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Balance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances": { + "get": { + "tags": [ + "Balances" + ], + "operationId": "Balances_GetForBillingPeriodByBillingAccount", + "description": "Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Balances": { + "$ref": "./examples/BalancesByBillingAccountForBillingPeriod.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Balance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries": { + "get": { + "tags": [ + "ReservationSummaries" + ], + "operationId": "ReservationsSummaries_ListByReservationOrder", + "description": "Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationSummariesDaily": { + "$ref": "./examples/ReservationSummariesDaily.json" + }, + "ReservationSummariesMonthly": { + "$ref": "./examples/ReservationSummariesMonthly.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "$filter", + "description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries": { + "get": { + "tags": [ + "ReservationSummaries" + ], + "operationId": "ReservationsSummaries_ListByReservationOrderAndReservation", + "description": "Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationSummariesDailyWithReservationId": { + "$ref": "./examples/ReservationSummariesDailyWithReservationId.json" + }, + "ReservationSummariesMonthlyWithReservationId": { + "$ref": "./examples/ReservationSummariesMonthlyWithReservationId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "#/parameters/reservationIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "$filter", + "description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceScope}/providers/Microsoft.Consumption/reservationSummaries": { + "get": { + "tags": [ + "ReservationSummaries" + ], + "operationId": "ReservationsSummaries_List", + "description": "Lists the reservations summaries for the defined scope daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationSummariesDailyWithBillingAccountId": { + "$ref": "./examples/ReservationSummariesDailyWithBillingAccountId.json" + }, + "ReservationSummariesMonthlyWithBillingAccountId": { + "$ref": "./examples/ReservationSummariesMonthlyWithBillingAccountId.json" + }, + "ReservationSummariesDailyWithBillingProfileId": { + "$ref": "./examples/ReservationSummariesDailyWithBillingProfileId.json" + }, + "ReservationSummariesMonthlyWithBillingProfileId": { + "$ref": "./examples/ReservationSummariesMonthlyWithBillingProfileId.json" + }, + "ReservationSummariesMonthlyWithBillingProfileIdReservationId": { + "$ref": "./examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeReservationsSummariesParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "startDate", + "in": "query", + "description": "Start date. Only applicable when querying with billing profile", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "endDate", + "in": "query", + "description": "End date. Only applicable when querying with billing profile", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "$filter", + "description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "reservationId", + "in": "query", + "description": "Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "reservationOrderId", + "in": "query", + "description": "Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails": { + "get": { + "tags": [ + "ReservationDetails" + ], + "operationId": "ReservationsDetails_ListByReservationOrder", + "description": "Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationDetails": { + "$ref": "./examples/ReservationDetails.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "name": "$filter", + "description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails": { + "get": { + "tags": [ + "ReservationDetails" + ], + "operationId": "ReservationsDetails_ListByReservationOrderAndReservation", + "description": "Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationDetailsWithReservationId": { + "$ref": "./examples/ReservationDetailsWithReservationId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "#/parameters/reservationIdParameter" + }, + { + "name": "$filter", + "description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceScope}/providers/Microsoft.Consumption/reservationDetails": { + "get": { + "tags": [ + "ReservationDetails" + ], + "operationId": "ReservationsDetails_List", + "description": "Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationDetailsByBillingAccountId": { + "$ref": "./examples/ReservationDetailsByBillingAccountId.json" + }, + "ReservationDetailsByBillingProfileId": { + "$ref": "./examples/ReservationDetailsByBillingProfileId.json" + }, + "ReservationDetailsByBillingProfileIdReservationId": { + "$ref": "./examples/ReservationDetailsByBillingProfileIdReservationId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeReservationDetailsParameter" + }, + { + "name": "startDate", + "in": "query", + "description": "Start date. Only applicable when querying with billing profile", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "endDate", + "in": "query", + "description": "End date. Only applicable when querying with billing profile", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "$filter", + "description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "reservationId", + "in": "query", + "description": "Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "reservationOrderId", + "in": "query", + "description": "Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendations": { + "get": { + "tags": [ + "ReservationRecommendations" + ], + "operationId": "ReservationRecommendations_List", + "description": "List of recommendations for purchasing reserved instances.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationRecommendationsBySubscription-Legacy": { + "$ref": "./examples/ReservationRecommendationsBySubscription.json" + }, + "ReservationRecommendationsByResourceGroup-Legacy": { + "$ref": "./examples/ReservationRecommendationsByResourceGroup.json" + }, + "ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod-Legacy": { + "$ref": "./examples/ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod.json" + }, + "ReservationRecommendationsByBillingAccount-Legacy": { + "$ref": "./examples/ReservationRecommendationsByBillingAccount.json" + }, + "ReservationRecommendationsByBillingAccountFilterForScope": { + "$ref": "./examples/ReservationRecommendationsByBillingAccountFilterByScope.json" + }, + "ReservationRecommendationsByBillingProfile-Modern": { + "$ref": "./examples/ReservationRecommendationsByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeReservationRecommendationsParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationRecommendationsListResult" + } + }, + "204": { + "description": "An empty response is sent when there are no recommendations." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails": { + "get": { + "tags": [ + "ReservationRecommendationDetails" + ], + "operationId": "ReservationRecommendationDetails_Get", + "description": "Details of a reservation recommendation for what-if analysis of reserved instances.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationRecommendationsBySubscription-Legacy": { + "$ref": "./examples/ReservationRecommendationDetailsBySubscription.json" + }, + "ReservationRecommendationsByResourceGroup-Legacy": { + "$ref": "./examples/ReservationRecommendationDetailsByResourceGroup.json" + }, + "ReservationRecommendationsByBillingAccount-Legacy": { + "$ref": "./examples/ReservationRecommendationDetailsByBillingAccount.json" + }, + "ReservationRecommendationsByBillingProfile-Modern": { + "$ref": "./examples/ReservationRecommendationDetailsByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeReservationRecommendationDetailsParameter" + }, + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/termParameter" + }, + { + "$ref": "#/parameters/lookBackPeriodParameter" + }, + { + "$ref": "#/parameters/productParameter" + }, + { + "$ref": "#/parameters/recommendationDetailsFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationRecommendationDetailsModel" + } + }, + "204": { + "description": "An empty response is sent when there are no recommendation details." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/HighCasedErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions": { + "get": { + "tags": [ + "ReservationTransactions" + ], + "operationId": "ReservationTransactions_List", + "description": "List of transactions for reserved instances on billing account scope. Note: The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationTransactionsByEnrollmentNumber": { + "$ref": "./examples/ReservationTransactionsListByEnrollmentNumber.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for the entire December 2020 month (i.e. will contain records for dates December 30 and 31)", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/useMarkupIfPartnerParameter" + }, + { + "$ref": "#/parameters/previewMarkupPercentage" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationTransactionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/reservationTransactions": { + "get": { + "tags": [ + "ReservationTransactions" + ], + "operationId": "ReservationTransactions_ListByBillingProfile", + "description": "List of transactions for reserved instances on billing profile scope. The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationTransactionsByBillingProfileId": { + "$ref": "./examples/ReservationTransactionsListByBillingProfileId.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for entire December 2020 month (i.e. will contain records for dates December 30 and 31)", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingProfileIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ModernReservationTransactionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default": { + "get": { + "tags": [ + "PriceSheet" + ], + "operationId": "PriceSheet_Get", + "description": "Gets the price sheet for a subscription. Price sheet is available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "PriceSheet": { + "$ref": "./examples/PriceSheet.json" + } + }, + "parameters": [ + { + "name": "$expand", + "description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the top N results.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PriceSheetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default": { + "get": { + "tags": [ + "PriceSheet" + ], + "operationId": "PriceSheet_GetByBillingPeriod", + "description": "Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "PriceSheetForBillingPeriod": { + "$ref": "./examples/PriceSheetForBillingPeriod.json" + }, + "PriceSheetExpand": { + "$ref": "./examples/PriceSheetExpand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the top N results.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PriceSheetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Consumption/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available consumption REST API operations.", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost": { + "get": { + "tags": [ + "AggregatedCost" + ], + "operationId": "AggregatedCost_GetByManagementGroup", + "description": "Provides the aggregate cost of a management group and all child management groups by current billing period.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "AggregatedCostByManagementGroup": { + "$ref": "./examples/AggregatedCostByManagementGroup.json" + }, + "AggregatedCostByManagementGroupFilterByDate": { + "$ref": "./examples/AggregatedCostByManagementGroupFilterByDate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter aggregated cost by properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ManagementGroupAggregatedCostResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/aggregatedCost": { + "get": { + "tags": [ + "AggregatedCost" + ], + "operationId": "AggregatedCost_GetForBillingPeriodByManagementGroup", + "description": "Provides the aggregate cost of a management group and all child management groups by specified billing period", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "AggregatedCostListForBillingPeriodByManagementGroup": { + "$ref": "./examples/AggregatedCostForBillingPeriodByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ManagementGroupAggregatedCostResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events": { + "get": { + "tags": [ + "Events" + ], + "operationId": "Events_ListByBillingProfile", + "description": "Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "EventsListByBillingProfile": { + "$ref": "./examples/EventsListByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingProfileIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/startDateParameter" + }, + { + "$ref": "#/parameters/endDateParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Events" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/events": { + "get": { + "tags": [ + "Events" + ], + "operationId": "Events_ListByBillingAccount", + "description": "Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "EventsGetByBillingAccount-Primary": { + "$ref": "./examples/EventsGetByBillingAccount-Primary.json" + }, + "EventsGetByBillingAccount-Contributor": { + "$ref": "./examples/EventsGetByBillingAccount-Contributor.json" + }, + "EventsGetByBillingAccount": { + "$ref": "./examples/EventsGetByBillingAccount.json" + }, + "EventsGetByBillingAccountWithFilters-Primary": { + "$ref": "./examples/EventsGetByBillingAccountWithFilters-Primary.json" + }, + "EventsGetByBillingAccountWithFilters-Contributor.json": { + "$ref": "./examples/EventsGetByBillingAccountWithFilters-Contributor.json" + }, + "EventsGetByBillingAccountWithFilters": { + "$ref": "./examples/EventsGetByBillingAccountWithFilters.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter the events by lotId, lotSource etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Events" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/lots": { + "get": { + "tags": [ + "Lots" + ], + "operationId": "Lots_ListByBillingProfile", + "description": "Lists all Azure credits for a billing account or a billing profile. The API is only supported for Microsoft Customer Agreements (MCA) billing accounts.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "LotsListByBillingProfile": { + "$ref": "./examples/LotsListByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingProfileIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Lots" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/lots": { + "get": { + "tags": [ + "Lots" + ], + "operationId": "Lots_ListByBillingAccount", + "description": "Lists all Microsoft Azure consumption commitments for a billing account. The API is only supported for Microsoft Customer Agreements (MCA) and Direct Enterprise Agreement (EA) billing accounts.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "LotsListByBillingAccount-Primary": { + "$ref": "./examples/LotsListByBillingAccount-Primary.json" + }, + "LotsListByBillingAccount-Contributor": { + "$ref": "./examples/LotsListByBillingAccount-Contributor.json" + }, + "LotsListByBillingAccount": { + "$ref": "./examples/LotsListByBillingAccount.json" + }, + "LotsListByBillingAccountWithStatusFilter-Primary": { + "$ref": "./examples/LotsListByBillingAccountWithFilters-Primary.json" + }, + "LotsListByBillingAccountWithStatusFilter-Contributor": { + "$ref": "./examples/LotsListByBillingAccountWithFilters-Contributor.json" + }, + "LotsListByBillingAccountWithStatusFilter": { + "$ref": "./examples/LotsListByBillingAccountWithFilters.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter the lots by Status, Source etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Lots" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}/providers/Microsoft.Consumption/lots": { + "get": { + "tags": [ + "Lots" + ], + "operationId": "Lots_ListByCustomer", + "description": "Lists all Azure credits for a customer. The API is only supported for Microsoft Partner Agreements (MPA) billing accounts.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "LotsListByCustomer": { + "$ref": "./examples/LotsListByCustomer.json" + }, + "LotsListByCustomerWithFilter": { + "$ref": "./examples/LotsListByCustomerWithFilters.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/customerIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter the lots by Status, Source etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. Tag filter is a key value pair string where key and value is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Lots" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/credits/balanceSummary": { + "get": { + "tags": [ + "Credits" + ], + "operationId": "Credits_Get", + "description": "The credit summary by billingAccountId and billingProfileId.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CreditSummaryByBillingProfile": { + "$ref": "./examples/CreditSummaryByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingProfileIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CreditSummary" + } + }, + "204": { + "description": "No Content. The request has succeeded but returned no results." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "MeterDetails": { + "description": "The properties of the meter detail.", + "properties": { + "meterName": { + "description": "The name of the meter, within the given meter category", + "type": "string", + "readOnly": true + }, + "meterCategory": { + "description": "The category of the meter, for example, 'Cloud services', 'Networking', etc..", + "type": "string", + "readOnly": true + }, + "meterSubCategory": { + "description": "The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.", + "type": "string", + "readOnly": true + }, + "meterLocation": { + "description": "The location in which the Azure service is available.", + "type": "string", + "readOnly": true + }, + "totalIncludedQuantity": { + "description": "The total included quantity associated with the offer.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "pretaxStandardRate": { + "description": "The pretax listing price.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "serviceName": { + "description": "The name of the service.", + "type": "string", + "readOnly": true + }, + "serviceTier": { + "description": "The service tier.", + "type": "string", + "readOnly": true + } + } + }, + "SavingsPlan": { + "type": "object", + "description": "The properties of the SavingsPlan.", + "properties": { + "term": { + "description": "SavingsPlan term", + "type": "string", + "readOnly": true + }, + "marketPrice": { + "description": "SavingsPlan Market Price", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "effectivePrice": { + "description": "SavingsPlan Effective Price", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "UsageDetail": { + "type": "object", + "discriminator": "kind", + "description": "An usage detail resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "Specifies the kind of usage details.", + "enum": [ + "legacy", + "modern" + ], + "x-ms-enum": { + "name": "UsageDetailsKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ] + }, + "UsageDetailsListResult": { + "description": "Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.", + "properties": { + "value": { + "description": "The list of usage details.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UsageDetail" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "LegacyUsageDetail": { + "description": "Legacy usage detail.", + "type": "object", + "x-ms-discriminator-value": "legacy", + "properties": { + "properties": { + "description": "Properties for legacy usage details", + "$ref": "#/definitions/LegacyUsageDetailProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/UsageDetail" + } + ], + "required": [ + "properties" + ] + }, + "LegacyUsageDetailProperties": { + "description": "The properties of the legacy usage detail.", + "properties": { + "billingAccountId": { + "description": "Billing Account identifier.", + "type": "string", + "readOnly": true + }, + "billingAccountName": { + "description": "Billing Account Name.", + "type": "string", + "readOnly": true + }, + "billingPeriodStartDate": { + "description": "The billing period start date.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "billingPeriodEndDate": { + "description": "The billing period end date.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "billingProfileId": { + "description": "Billing Profile identifier.", + "type": "string", + "readOnly": true + }, + "billingProfileName": { + "description": "Billing Profile Name.", + "type": "string", + "readOnly": true + }, + "accountOwnerId": { + "description": "Account Owner Id.", + "type": "string", + "readOnly": true + }, + "accountName": { + "description": "Account Name.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "Subscription guid.", + "type": "string", + "readOnly": true + }, + "subscriptionName": { + "description": "Subscription name.", + "type": "string", + "readOnly": true + }, + "date": { + "description": "Date for the usage record.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "description": "Product name for the consumed service or purchase. Not available for Marketplace.", + "type": "string", + "readOnly": true + }, + "partNumber": { + "description": "Part Number of the service used. Can be used to join with the price sheet. Not available for marketplace.", + "type": "string", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID). Not available for marketplace. For reserved instance this represents the primary meter for which the reservation was purchased. For the actual VM Size for which the reservation is purchased see productOrderName.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "meterDetails": { + "description": "The details about the meter. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/MeterDetailsResponse", + "readOnly": true + }, + "quantity": { + "description": "The usage quantity.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "effectivePrice": { + "description": "Effective Price that's charged for the usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "cost": { + "description": "The amount of cost before tax.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unitPrice": { + "description": "Unit Price is the price applicable to you. (your EA or other contract price).", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "billingCurrency": { + "description": "Billing Currency.", + "type": "string", + "readOnly": true + }, + "resourceLocation": { + "description": "Resource Location.", + "type": "string", + "readOnly": true + }, + "consumedService": { + "description": "Consumed service name. Name of the azure resource provider that emits the usage or was purchased. This value is not provided for marketplace usage.", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "Unique identifier of the Azure Resource Manager usage detail resource.", + "type": "string", + "readOnly": true + }, + "resourceName": { + "description": "Resource Name.", + "type": "string", + "readOnly": true + }, + "serviceInfo1": { + "description": "Service-specific metadata.", + "type": "string", + "readOnly": true + }, + "serviceInfo2": { + "description": "Legacy field with optional service-specific metadata.", + "type": "string", + "readOnly": true + }, + "additionalInfo": { + "description": "Additional details of this usage item. By default this is not populated, unless it's specified in $expand. Use this field to get usage line item specific details such as the actual VM Size (ServiceType) or the ratio in which the reservation discount is applied.", + "type": "string", + "readOnly": true + }, + "invoiceSection": { + "description": "Invoice Section Name.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center of this department if it is a department and a cost center is provided.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "Resource Group Name.", + "type": "string", + "readOnly": true + }, + "reservationId": { + "description": "ARM resource id of the reservation. Only applies to records relevant to reservations.", + "type": "string", + "readOnly": true + }, + "reservationName": { + "description": "User provided display name of the reservation. Last known name for a particular day is populated in the daily data. Only applies to records relevant to reservations.", + "type": "string", + "readOnly": true + }, + "productOrderId": { + "description": "Product Order Id. For reservations this is the Reservation Order ID.", + "type": "string", + "readOnly": true + }, + "productOrderName": { + "description": "Product Order Name. For reservations this is the SKU that was purchased.", + "type": "string", + "readOnly": true + }, + "offerId": { + "description": "Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P.", + "type": "string", + "readOnly": true + }, + "isAzureCreditEligible": { + "description": "Is Azure Credit Eligible.", + "type": "boolean", + "readOnly": true + }, + "term": { + "description": "Term (in months). 1 month for monthly recurring purchase. 12 months for a 1 year reservation. 36 months for a 3 year reservation.", + "type": "string", + "readOnly": true + }, + "publisherName": { + "description": "Publisher Name.", + "type": "string", + "readOnly": true + }, + "publisherType": { + "description": "Publisher Type.", + "type": "string", + "readOnly": true + }, + "planName": { + "description": "Plan Name.", + "type": "string", + "readOnly": true + }, + "chargeType": { + "description": "Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund.", + "type": "string", + "readOnly": true + }, + "frequency": { + "description": "Indicates how frequently this charge will occur. OneTime for purchases which only happen once, Monthly for fees which recur every month, and UsageBased for charges based on how much a service is used.", + "type": "string", + "readOnly": true + }, + "payGPrice": { + "description": "Retail price for the resource.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "benefitId": { + "description": "Unique identifier for the applicable benefit.", + "type": "string", + "readOnly": true + }, + "benefitName": { + "description": "Name of the applicable benefit.", + "type": "string", + "readOnly": true + }, + "pricingModel": { + "description": "Identifier that indicates how the meter is priced.", + "type": "string", + "readOnly": true, + "enum": [ + "On Demand", + "Reservation", + "Spot" + ], + "x-ms-enum": { + "name": "pricingModelType", + "modelAsString": true + } + } + } + }, + "ModernUsageDetail": { + "description": "Modern usage detail.", + "type": "object", + "x-ms-discriminator-value": "modern", + "properties": { + "properties": { + "description": "Properties for modern usage details", + "$ref": "#/definitions/ModernUsageDetailProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/UsageDetail" + } + ], + "required": [ + "properties" + ] + }, + "ModernUsageDetailProperties": { + "description": "The properties of the usage detail.", + "properties": { + "billingAccountId": { + "description": "Billing Account identifier.", + "type": "string", + "readOnly": true + }, + "effectivePrice": { + "description": "Effective Price that's charged for the usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "pricingModel": { + "description": "Identifier that indicates how the meter is priced", + "type": "string", + "readOnly": true, + "enum": [ + "On Demand", + "Reservation", + "Spot" + ], + "x-ms-enum": { + "name": "pricingModelType", + "modelAsString": true + } + }, + "billingAccountName": { + "description": "Name of the Billing Account.", + "type": "string", + "readOnly": true + }, + "billingPeriodStartDate": { + "description": "Billing Period Start Date as in the invoice.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "billingPeriodEndDate": { + "description": "Billing Period End Date as in the invoice.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "billingProfileId": { + "description": "Identifier for the billing profile that groups costs across invoices in the a singular billing currency across across the customers who have onboarded the Microsoft customer agreement and the customers in CSP who have made entitlement purchases like SaaS, Marketplace, RI, etc.", + "type": "string", + "readOnly": true + }, + "billingProfileName": { + "description": "Name of the billing profile that groups costs across invoices in the a singular billing currency across across the customers who have onboarded the Microsoft customer agreement and the customers in CSP who have made entitlement purchases like SaaS, Marketplace, RI, etc.", + "type": "string", + "readOnly": true + }, + "subscriptionGuid": { + "description": "Unique Microsoft generated identifier for the Azure Subscription.", + "type": "string", + "readOnly": true + }, + "subscriptionName": { + "description": "Name of the Azure Subscription.", + "type": "string", + "readOnly": true + }, + "date": { + "description": "Date for the usage record.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "description": "Name of the product that has accrued charges by consumption or purchase as listed in the invoice. Not available for Marketplace.", + "type": "string", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID). Not available for marketplace. For reserved instance this represents the primary meter for which the reservation was purchased. For the actual VM Size for which the reservation is purchased see productOrderName.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "meterName": { + "description": "Identifies the name of the meter against which consumption is measured.", + "type": "string", + "readOnly": true + }, + "meterRegion": { + "description": "Identifies the location of the datacenter for certain services that are priced based on datacenter location.", + "type": "string", + "readOnly": true + }, + "meterCategory": { + "description": "Identifies the top-level service for the usage.", + "type": "string", + "readOnly": true + }, + "meterSubCategory": { + "description": "Defines the type or sub-category of Azure service that can affect the rate.", + "type": "string", + "readOnly": true + }, + "serviceFamily": { + "description": "List the service family for the product purchased or charged (Example: Storage ; Compute).", + "type": "string", + "readOnly": true + }, + "quantity": { + "description": "Measure the quantity purchased or consumed.The amount of the meter used during the billing period.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unitOfMeasure": { + "description": "Identifies the Unit that the service is charged in. For example, GB, hours, 10,000 s.", + "type": "string", + "readOnly": true + }, + "instanceName": { + "description": "Instance Name.", + "type": "string", + "readOnly": true + }, + "costInUSD": { + "description": "Estimated extendedCost or blended cost before tax in USD.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unitPrice": { + "description": "Unit Price is the price applicable to you. (your EA or other contract price).", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "billingCurrencyCode": { + "description": "The currency defining the billed cost.", + "type": "string", + "readOnly": true + }, + "resourceLocation": { + "description": "Name of the resource location.", + "type": "string", + "readOnly": true + }, + "consumedService": { + "description": "Consumed service name. Name of the azure resource provider that emits the usage or was purchased. This value is not provided for marketplace usage.", + "type": "string", + "readOnly": true + }, + "serviceInfo1": { + "description": "Service-specific metadata.", + "type": "string", + "readOnly": true + }, + "serviceInfo2": { + "description": "Legacy field with optional service-specific metadata.", + "type": "string", + "readOnly": true + }, + "additionalInfo": { + "description": "Additional details of this usage item. Use this field to get usage line item specific details such as the actual VM Size (ServiceType) or the ratio in which the reservation discount is applied.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "Identifier of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners.", + "type": "string", + "readOnly": true + }, + "invoiceSectionName": { + "description": "Name of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center of this department if it is a department and a cost center is provided.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "Name of the Azure resource group used for cohesive lifecycle management of resources.", + "type": "string", + "readOnly": true + }, + "reservationId": { + "description": "ARM resource id of the reservation. Only applies to records relevant to reservations.", + "type": "string", + "readOnly": true + }, + "reservationName": { + "description": "User provided display name of the reservation. Last known name for a particular day is populated in the daily data. Only applies to records relevant to reservations.", + "type": "string", + "readOnly": true + }, + "productOrderId": { + "description": "The identifier for the asset or Azure plan name that the subscription belongs to. For example: Azure Plan. For reservations this is the Reservation Order ID.", + "type": "string", + "readOnly": true + }, + "productOrderName": { + "description": "Product Order Name. For reservations this is the SKU that was purchased.", + "type": "string", + "readOnly": true + }, + "isAzureCreditEligible": { + "description": "Determines if the cost is eligible to be paid for using Azure credits.", + "type": "boolean", + "readOnly": true + }, + "term": { + "description": "Term (in months). Displays the term for the validity of the offer. For example. In case of reserved instances it displays 12 months for yearly term of reserved instance. For one time purchases or recurring purchases, the terms displays 1 month; This is not applicable for Azure consumption.", + "type": "string", + "readOnly": true + }, + "publisherName": { + "description": "Name of the publisher of the service including Microsoft or Third Party publishers.", + "type": "string", + "readOnly": true + }, + "publisherType": { + "description": "Type of publisher that identifies if the publisher is first party, third party reseller or third party agency.", + "type": "string", + "readOnly": true + }, + "chargeType": { + "description": "Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund.", + "type": "string", + "readOnly": true + }, + "frequency": { + "description": "Indicates how frequently this charge will occur. OneTime for purchases which only happen once, Monthly for fees which recur every month, and UsageBased for charges based on how much a service is used.", + "type": "string", + "readOnly": true + }, + "costInBillingCurrency": { + "description": "ExtendedCost or blended cost before tax in billed currency.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "costInPricingCurrency": { + "description": "ExtendedCost or blended cost before tax in pricing currency to correlate with prices.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "exchangeRate": { + "description": "Exchange rate used in conversion from pricing currency to billing currency.", + "type": "string", + "readOnly": true + }, + "exchangeRateDate": { + "description": "Date on which exchange rate used in conversion from pricing currency to billing currency.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "invoiceId": { + "description": "Invoice ID as on the invoice where the specific transaction appears.", + "type": "string", + "readOnly": true + }, + "previousInvoiceId": { + "description": "Reference to an original invoice there is a refund (negative cost). This is populated only when there is a refund.", + "type": "string", + "readOnly": true + }, + "pricingCurrencyCode": { + "description": "Pricing Billing Currency.", + "type": "string", + "readOnly": true + }, + "productIdentifier": { + "description": "Identifier for the product that has accrued charges by consumption or purchase . This is the concatenated key of productId and SkuId in partner center.", + "type": "string", + "readOnly": true + }, + "resourceLocationNormalized": { + "description": "Resource Location Normalized.", + "type": "string", + "readOnly": true + }, + "servicePeriodStartDate": { + "description": "Start date for the rating period when the service usage was rated for charges. The prices for Azure services are determined for the rating period.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "servicePeriodEndDate": { + "description": "End date for the period when the service usage was rated for charges. The prices for Azure services are determined based on the rating period.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customerTenantId": { + "description": "Identifier of the customer's AAD tenant.", + "type": "string", + "readOnly": true + }, + "customerName": { + "description": "Name of the customer's AAD tenant.", + "type": "string", + "readOnly": true + }, + "partnerTenantId": { + "description": "Identifier for the partner's AAD tenant.", + "type": "string", + "readOnly": true + }, + "partnerName": { + "description": "Name of the partner' AAD tenant.", + "type": "string", + "readOnly": true + }, + "resellerMpnId": { + "description": "MPNId for the reseller associated with the subscription.", + "type": "string", + "readOnly": true + }, + "resellerName": { + "description": "Reseller Name.", + "type": "string", + "readOnly": true + }, + "publisherId": { + "description": "Publisher Id.", + "type": "string", + "readOnly": true + }, + "marketPrice": { + "description": "Market Price that's charged for the usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "exchangeRatePricingToBilling": { + "description": "Exchange Rate from pricing currency to billing currency.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "paygCostInBillingCurrency": { + "description": "The amount of PayG cost before tax in billing currency.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "paygCostInUSD": { + "description": "The amount of PayG cost before tax in US Dollar currency.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "partnerEarnedCreditRate": { + "description": "Rate of discount applied if there is a partner earned credit (PEC) based on partner admin link access.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "partnerEarnedCreditApplied": { + "description": "Flag to indicate if partner earned credit has been applied or not.", + "type": "string", + "readOnly": true + }, + "payGPrice": { + "description": "Retail price for the resource.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "benefitId": { + "description": "Unique identifier for the applicable benefit.", + "type": "string", + "readOnly": true + }, + "benefitName": { + "description": "Name of the applicable benefit.", + "type": "string", + "readOnly": true + }, + "provider": { + "description": "Identifier for Product Category or Line Of Business, Ex - Azure, Microsoft 365, AWS e.t.c", + "type": "string", + "readOnly": true + }, + "costAllocationRuleName": { + "description": "Name for Cost Allocation Rule.", + "type": "string", + "readOnly": true + } + } + }, + "Marketplace": { + "description": "A marketplace resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MarketplaceProperties", + "title": "Marketplace properties" + } + } + }, + "MarketplacesListResult": { + "description": "Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.", + "type": "object", + "properties": { + "value": { + "description": "The list of marketplaces.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Marketplace" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "MarketplaceProperties": { + "description": "The properties of the marketplace usage detail.", + "type": "object", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "The start of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usageEnd": { + "description": "The end of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "resourceRate": { + "description": "The marketplace resource rate.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "offerName": { + "description": "The type of offer.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "The name of resource group.", + "type": "string", + "readOnly": true + }, + "additionalInfo": { + "description": "Additional information.", + "type": "string", + "readOnly": true + }, + "orderNumber": { + "description": "The order number.", + "type": "string", + "readOnly": true + }, + "instanceName": { + "description": "The name of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "instanceId": { + "description": "The uri of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "consumedQuantity": { + "description": "The quantity of usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unitOfMeasure": { + "description": "The unit of measure.", + "type": "string", + "readOnly": true + }, + "pretaxCost": { + "description": "The amount of cost before tax.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "isEstimated": { + "description": "The estimated usage is subject to change.", + "type": "boolean", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID).", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "subscriptionGuid": { + "description": "Subscription guid.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "subscriptionName": { + "description": "Subscription name.", + "type": "string", + "readOnly": true + }, + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "departmentName": { + "description": "Department name.", + "type": "string", + "readOnly": true + }, + "consumedService": { + "description": "Consumed service name.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center of this department if it is a department and a costcenter exists", + "type": "string", + "readOnly": true + }, + "additionalProperties": { + "description": "Additional details of this usage item. By default this is not populated, unless it's specified in $expand.", + "type": "string", + "readOnly": true + }, + "publisherName": { + "description": "The name of publisher.", + "type": "string", + "readOnly": true + }, + "planName": { + "description": "The name of plan.", + "type": "string", + "readOnly": true + }, + "isRecurringCharge": { + "description": "Flag indicating whether this is a recurring charge or not.", + "type": "boolean", + "readOnly": true + } + } + }, + "Balance": { + "description": "A balance resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BalanceProperties", + "title": "Balance properties" + } + } + }, + "BalanceProperties": { + "description": "The properties of the balance.", + "type": "object", + "properties": { + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "beginningBalance": { + "description": "The beginning balance for the billing period.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "endingBalance": { + "description": "The ending balance for the billing period (for open periods this will be updated daily).", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "newPurchases": { + "description": "Total new purchase amount.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "adjustments": { + "description": "Total adjustment amount.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "utilized": { + "description": "Total Commitment usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "serviceOverage": { + "description": "Overage for Azure services.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges Billed separately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalOverage": { + "description": "serviceOverage + chargesBilledSeparately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalUsage": { + "description": "Azure service commitment + total Overage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "azureMarketplaceServiceCharges": { + "description": "Total charges for Azure Marketplace.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "billingFrequency": { + "description": "The billing frequency.", + "type": "string", + "enum": [ + "Month", + "Quarter", + "Year" + ], + "x-ms-enum": { + "name": "BillingFrequency", + "modelAsString": true + } + }, + "priceHidden": { + "description": "Price is hidden or not.", + "type": "boolean", + "readOnly": true + }, + "overageRefund": { + "description": "Overage Refunds", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "newPurchasesDetails": { + "description": "List of new purchases.", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "the name of new purchase.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "the value of new purchase.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "adjustmentDetails": { + "description": "List of Adjustments (Promo credit, SIE credit etc.).", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "the name of new adjustment.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "the value of new adjustment.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + } + }, + "ReservationSummary": { + "description": "reservation summary resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationSummaryProperties", + "title": "Reservation Summary properties" + } + } + }, + "ReservationSummariesListResult": { + "description": "Result of listing reservation summaries.", + "properties": { + "value": { + "description": "The list of reservation summaries.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReservationSummary" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationSummaryProperties": { + "description": "The properties of the reservation summary.", + "properties": { + "reservationOrderId": { + "description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.", + "type": "string", + "readOnly": true + }, + "reservationId": { + "description": "The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.", + "type": "string", + "readOnly": true + }, + "skuName": { + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", + "type": "string", + "readOnly": true + }, + "reservedHours": { + "description": "This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "usageDate": { + "description": "Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usedHours": { + "description": "Total used hours by the reservation", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "minUtilizationPercentage": { + "description": "This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "avgUtilizationPercentage": { + "description": "This is average utilization for the entire time range. (day or month depending on the grain)", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "maxUtilizationPercentage": { + "description": "This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "kind": { + "description": "The reservation kind.", + "type": "string", + "readOnly": true + }, + "purchasedQuantity": { + "description": "This is the purchased quantity for the reservationId.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "remainingQuantity": { + "description": "This is the remaining quantity for the reservationId.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalReservedQuantity": { + "description": "This is the total count of instances that are reserved for the reservationId.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "usedQuantity": { + "description": "This is the used quantity for the reservationId.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "utilizedPercentage": { + "description": "This is the utilized percentage for the reservation Id.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "ReservationDetail": { + "description": "reservation detail resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationDetailProperties", + "title": "Reservation Detail properties" + } + } + }, + "ReservationDetailsListResult": { + "description": "Result of listing reservation details.", + "properties": { + "value": { + "description": "The list of reservation details.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReservationDetail" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationDetailProperties": { + "description": "The properties of the reservation detail.", + "properties": { + "reservationOrderId": { + "description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.", + "type": "string", + "readOnly": true + }, + "instanceFlexibilityRatio": { + "description": "The instance Flexibility Ratio.", + "type": "string", + "readOnly": true + }, + "instanceFlexibilityGroup": { + "description": "The instance Flexibility Group.", + "type": "string", + "readOnly": true + }, + "reservationId": { + "description": "The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.", + "type": "string", + "readOnly": true + }, + "skuName": { + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", + "type": "string", + "readOnly": true + }, + "reservedHours": { + "description": "This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "usageDate": { + "description": "The date on which consumption occurred.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usedHours": { + "description": "This is the total hours used by the instance.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "instanceId": { + "description": "This identifier is the name of the resource or the fully qualified Resource ID.", + "type": "string", + "readOnly": true + }, + "totalReservedQuantity": { + "description": "This is the total count of instances that are reserved for the reservationId.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "kind": { + "description": "The reservation kind.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationRecommendationDetailsModel": { + "description": "Reservation recommendation details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource Location." + }, + "sku": { + "type": "string", + "description": "Resource sku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationRecommendationDetailsProperties", + "title": "Reservation Recommendation details properties" + } + } + }, + "ReservationRecommendationDetailsProperties": { + "description": "The properties of the reservation recommendation.", + "properties": { + "currency": { + "description": "An ISO 4217 currency code identifier for the costs and savings ", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource specific properties.", + "$ref": "#/definitions/ReservationRecommendationDetailsResourceProperties", + "readOnly": true + }, + "resourceGroup": { + "description": "Resource Group.", + "type": "string", + "readOnly": true + }, + "savings": { + "description": "Savings information for the recommendation.", + "$ref": "#/definitions/ReservationRecommendationDetailsSavingsProperties", + "readOnly": true + }, + "scope": { + "description": "Scope of the reservation, ex: Single or Shared.", + "type": "string", + "readOnly": true + }, + "usage": { + "description": "Historical usage details used to calculate the estimated savings.", + "$ref": "#/definitions/ReservationRecommendationDetailsUsageProperties", + "readOnly": true + } + } + }, + "ReservationRecommendationDetailsCalculatedSavingsProperties": { + "description": "Details of estimated savings. The costs and savings are estimated for the term.", + "properties": { + "onDemandCost": { + "description": "The cost without reservation. Includes hardware and software cost.", + "type": "number", + "readOnly": true + }, + "overageCost": { + "description": "Hardware and software cost of the resources not covered by the reservation.", + "type": "number", + "readOnly": true + }, + "quantity": { + "description": "The quantity for calculated savings.", + "type": "number", + "readOnly": true + }, + "reservationCost": { + "description": "Hardware cost of the resources covered by the reservation.", + "type": "number", + "readOnly": true + }, + "totalReservationCost": { + "description": "Reservation cost + software cost of the resources covered by the reservation + overage cost.", + "type": "number", + "readOnly": true + }, + "reservedUnitCount": { + "description": "The number of reserved units used to calculate savings. Always 1 for virtual machines.", + "type": "number" + }, + "savings": { + "description": "The amount saved by purchasing the recommended quantity of reservation. This is equal to onDemandCost - totalReservationCost.", + "type": "number", + "readOnly": true + } + } + }, + "ReservationRecommendationDetailsResourceProperties": { + "description": "Details of the resource.", + "properties": { + "appliedScopes": { + "description": "List of subscriptions for which the reservation is applied.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "onDemandRate": { + "description": "Hourly on-demand rate of the resource. Includes only hardware rate i.e, software rate is not included.", + "type": "number", + "readOnly": true + }, + "product": { + "description": "Azure product ex: Standard_E8s_v3 etc.", + "type": "string", + "readOnly": true + }, + "region": { + "description": "Azure resource region ex:EastUS, WestUS etc.", + "type": "string", + "readOnly": true + }, + "reservationRate": { + "description": "Hourly reservation rate of the resource. Varies based on the term.", + "type": "number", + "readOnly": true + }, + "resourceType": { + "description": "The azure resource type.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationRecommendationDetailsSavingsProperties": { + "description": "Details of the estimated savings.", + "properties": { + "calculatedSavings": { + "description": "List of calculated savings.", + "type": "array", + "items": { + "$ref": "#/definitions/ReservationRecommendationDetailsCalculatedSavingsProperties" + }, + "x-ms-identifiers": [] + }, + "lookBackPeriod": { + "description": "Number of days of usage to look back used for computing the recommendation.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "recommendedQuantity": { + "description": "Number of recommended units of the resource.", + "type": "number", + "readOnly": true + }, + "reservationOrderTerm": { + "description": "Term period of the reservation. ex: P1M, P1Y or P3Y.", + "type": "string", + "readOnly": true + }, + "savingsType": { + "description": "Type of savings, ex: instance.", + "type": "string", + "readOnly": true + }, + "unitOfMeasure": { + "description": "Measurement unit ex: hour etc.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationRecommendationDetailsUsageProperties": { + "description": "Details about historical usage data that has been used for computing the recommendation.", + "properties": { + "firstConsumptionDate": { + "description": "The first usage date used for looking back for computing the recommendation.", + "type": "string", + "readOnly": true + }, + "lastConsumptionDate": { + "description": "The last usage date used for looking back for computing the recommendation.", + "type": "string", + "readOnly": true + }, + "lookBackUnitType": { + "description": "What the usage data values represent ex: virtual machine instance.", + "type": "string", + "readOnly": true + }, + "usageData": { + "description": "The breakdown of historical resource usage. The values are in the order of usage between the firstConsumptionDate and the lastConsumptionDate.", + "type": "array", + "items": { + "type": "number" + }, + "readOnly": true + }, + "usageGrain": { + "description": "The grain of the values represented in the usage data ex: hourly.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationRecommendationsListResult": { + "description": "Result of listing reservation recommendations.", + "properties": { + "value": { + "description": "The list of reservation recommendations.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReservationRecommendation" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "previousLink": { + "description": "The link (url) to the previous page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationRecommendation": { + "description": "A reservation recommendation resource.", + "type": "object", + "discriminator": "kind", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ResourceAttributes" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "Specifies the kind of reservation recommendation.", + "enum": [ + "legacy", + "modern" + ], + "x-ms-enum": { + "name": "ReservationRecommendationKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ] + }, + "LegacyReservationRecommendation": { + "description": "Legacy reservation recommendation.", + "type": "object", + "x-ms-discriminator-value": "legacy", + "properties": { + "properties": { + "description": "Properties for legacy reservation recommendation", + "$ref": "#/definitions/LegacyReservationRecommendationProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ReservationRecommendation" + } + ], + "required": [ + "properties" + ] + }, + "LegacyReservationRecommendationProperties": { + "description": "The properties of the reservation recommendation.", + "type": "object", + "discriminator": "scope", + "properties": { + "lookBackPeriod": { + "description": "The number of days of usage to look back for recommendation.", + "type": "string", + "readOnly": true + }, + "instanceFlexibilityRatio": { + "description": "The instance Flexibility Ratio.", + "type": "number", + "readOnly": true + }, + "instanceFlexibilityGroup": { + "description": "The instance Flexibility Group.", + "type": "string", + "readOnly": true + }, + "normalizedSize": { + "description": "The normalized Size.", + "type": "string", + "readOnly": true + }, + "recommendedQuantityNormalized": { + "description": "The recommended Quantity Normalized.", + "type": "number", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID)", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "resourceType": { + "description": "The azure resource type.", + "type": "string", + "readOnly": true + }, + "term": { + "description": "Term period of the reservation. ex: P1M, P1Y or P3Y.", + "type": "string", + "readOnly": true + }, + "costWithNoReservedInstances": { + "description": "The total amount of cost without reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "recommendedQuantity": { + "description": "Recommended quality for reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalCostWithReservedInstances": { + "description": "The total amount of cost with reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "netSavings": { + "description": "Total estimated savings with reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "firstUsageDate": { + "description": "The usage date for looking back.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scope": { + "description": "Shared or single recommendation.", + "type": "string" + }, + "skuProperties": { + "description": "List of sku properties", + "type": "array", + "items": { + "$ref": "#/definitions/SkuProperty" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "lastUsageDate": { + "description": "The last usage date used for looking back for computing the recommendation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "totalHours": { + "description": "The total hours for which the cost is covered.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "required": [ + "scope" + ] + }, + "LegacySingleScopeReservationRecommendationProperties": { + "description": "The properties of the legacy reservation recommendation for single scope.", + "type": "object", + "x-ms-discriminator-value": "Single", + "properties": { + "subscriptionId": { + "description": "Subscription id associated with single scoped recommendation.", + "type": "string", + "format": "uuid", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/LegacyReservationRecommendationProperties" + } + ] + }, + "LegacySharedScopeReservationRecommendationProperties": { + "description": "The properties of the legacy reservation recommendation for shared scope.", + "type": "object", + "x-ms-discriminator-value": "Shared", + "allOf": [ + { + "$ref": "#/definitions/LegacyReservationRecommendationProperties" + } + ] + }, + "SkuProperty": { + "description": "The Sku property", + "properties": { + "name": { + "description": "The name of sku property.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The value of sku property.", + "type": "string", + "readOnly": true + } + } + }, + "ModernReservationRecommendation": { + "description": "Modern reservation recommendation.", + "type": "object", + "x-ms-discriminator-value": "modern", + "properties": { + "properties": { + "description": "Properties for modern reservation recommendation", + "$ref": "#/definitions/ModernReservationRecommendationProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ReservationRecommendation" + } + ], + "required": [ + "properties" + ] + }, + "ModernReservationRecommendationProperties": { + "description": "The properties of the reservation recommendation.", + "type": "object", + "discriminator": "scope", + "properties": { + "location": { + "type": "string", + "description": "Resource Location.", + "readOnly": true + }, + "lookBackPeriod": { + "description": "The number of days of usage to look back for recommendation.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "instanceFlexibilityRatio": { + "description": "The instance Flexibility Ratio.", + "type": "number", + "readOnly": true + }, + "instanceFlexibilityGroup": { + "description": "The instance Flexibility Group.", + "type": "string", + "readOnly": true + }, + "normalizedSize": { + "description": "The normalized Size.", + "type": "string", + "readOnly": true + }, + "recommendedQuantityNormalized": { + "description": "The recommended Quantity Normalized.", + "type": "number", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID)", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "term": { + "description": "Term period of the reservation. ex: P1M, P1Y or P3Y.", + "type": "string", + "readOnly": true + }, + "costWithNoReservedInstances": { + "description": "The total amount of cost without reserved instances.", + "$ref": "#/definitions/amount", + "readOnly": true + }, + "recommendedQuantity": { + "description": "Recommended quality for reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "resourceType": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "totalCostWithReservedInstances": { + "description": "The total amount of cost with reserved instances.", + "$ref": "#/definitions/amount", + "readOnly": true + }, + "netSavings": { + "description": "Total estimated savings with reserved instances.", + "$ref": "#/definitions/amount", + "readOnly": true + }, + "firstUsageDate": { + "description": "The usage date for looking back.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scope": { + "description": "Shared or single recommendation.", + "type": "string" + }, + "skuProperties": { + "description": "List of sku properties", + "type": "array", + "items": { + "$ref": "#/definitions/SkuProperty" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "skuName": { + "description": "This is the ARM Sku name.", + "type": "string", + "readOnly": true + }, + "lastUsageDate": { + "description": "The last usage date used for looking back for computing the recommendation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "totalHours": { + "description": "The total hours for which the cost is covered.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "required": [ + "scope" + ] + }, + "ModernSingleScopeReservationRecommendationProperties": { + "description": "The properties of the modern reservation recommendation for single scope.", + "type": "object", + "x-ms-discriminator-value": "Single", + "properties": { + "subscriptionId": { + "description": "Subscription ID associated with single scoped recommendation.", + "type": "string", + "format": "uuid", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ModernReservationRecommendationProperties" + } + ] + }, + "ModernSharedScopeReservationRecommendationProperties": { + "description": "The properties of the modern reservation recommendation for shared scope.", + "type": "object", + "x-ms-discriminator-value": "Shared", + "allOf": [ + { + "$ref": "#/definitions/ModernReservationRecommendationProperties" + } + ] + }, + "ModernReservationTransactionProperties": { + "description": "The properties of a modern reservation transaction.", + "properties": { + "amount": { + "description": "The charge of the transaction.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "armSkuName": { + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", + "type": "string", + "readOnly": true + }, + "billingFrequency": { + "description": "The billing frequency, which can be either one-time or recurring.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "Billing profile Id.", + "type": "string", + "readOnly": true + }, + "billingProfileName": { + "description": "Billing profile name.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the transaction is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the transaction.", + "type": "string", + "readOnly": true + }, + "eventDate": { + "description": "The date of the transaction", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "eventType": { + "description": "The type of the transaction (Purchase, Cancel or Refund).", + "type": "string", + "readOnly": true + }, + "invoice": { + "description": "Invoice Number", + "type": "string", + "readOnly": true + }, + "invoiceId": { + "description": "Invoice Id as on the invoice where the specific transaction appears.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "Invoice Section Id", + "type": "string", + "readOnly": true + }, + "invoiceSectionName": { + "description": "Invoice Section Name.", + "type": "string", + "readOnly": true + }, + "purchasingSubscriptionGuid": { + "description": "The subscription guid that makes the transaction.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "purchasingSubscriptionName": { + "description": "The subscription name that makes the transaction.", + "type": "string", + "readOnly": true + }, + "quantity": { + "description": "The quantity of the transaction.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "region": { + "description": "The region of the transaction.", + "type": "string", + "readOnly": true + }, + "reservationOrderId": { + "description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.", + "type": "string", + "readOnly": true + }, + "reservationOrderName": { + "description": "The name of the reservation order.", + "type": "string", + "readOnly": true + }, + "term": { + "description": "This is the term of the transaction.", + "type": "string", + "readOnly": true + } + } + }, + "ModernReservationTransaction": { + "description": "Modern Reservation transaction resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReservationTransactionResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ModernReservationTransactionProperties", + "title": "Reservation Transaction properties" + } + }, + "required": [ + "properties" + ] + }, + "LegacyReservationTransaction": { + "description": "Legacy Reservation transaction resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReservationTransaction" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LegacyReservationTransactionProperties", + "title": "Reservation Transaction properties" + } + }, + "required": [ + "properties" + ] + }, + "LegacyReservationTransactionProperties": { + "description": "The properties of a legacy reservation transaction.", + "properties": { + "eventDate": { + "description": "The date of the transaction", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "reservationOrderId": { + "description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the transaction.", + "type": "string", + "readOnly": true + }, + "eventType": { + "description": "The type of the transaction (Purchase, Cancel or Refund).", + "type": "string", + "readOnly": true + }, + "quantity": { + "description": "The quantity of the transaction.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "amount": { + "description": "The charge of the transaction.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the transaction is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "reservationOrderName": { + "description": "The name of the reservation order.", + "type": "string", + "readOnly": true + }, + "purchasingEnrollment": { + "description": "The purchasing enrollment.", + "type": "string", + "readOnly": true + }, + "purchasingSubscriptionGuid": { + "description": "The subscription guid that makes the transaction.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "purchasingSubscriptionName": { + "description": "The subscription name that makes the transaction.", + "type": "string", + "readOnly": true + }, + "armSkuName": { + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", + "type": "string", + "readOnly": true + }, + "term": { + "description": "This is the term of the transaction.", + "type": "string", + "readOnly": true + }, + "region": { + "description": "The region of the transaction.", + "type": "string", + "readOnly": true + }, + "accountName": { + "description": "The name of the account that makes the transaction.", + "type": "string", + "readOnly": true + }, + "accountOwnerEmail": { + "description": "The email of the account owner that makes the transaction.", + "type": "string", + "readOnly": true + }, + "departmentName": { + "description": "The department name.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center of this department if it is a department and a cost center is provided.", + "type": "string", + "readOnly": true + }, + "currentEnrollment": { + "description": "The current enrollment.", + "type": "string", + "readOnly": true + }, + "billingFrequency": { + "description": "The billing frequency, which can be either one-time or recurring.", + "type": "string", + "readOnly": true + }, + "billingMonth": { + "description": "The billing month(yyyyMMdd), on which the event initiated.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "monetaryCommitment": { + "description": "The monetary commitment amount at the enrollment scope.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "overage": { + "description": "The overage amount at the enrollment scope.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "ReservationTransaction": { + "description": "Reservation transaction resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReservationTransactionResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LegacyReservationTransactionProperties", + "title": "Reservation Transaction properties" + } + } + }, + "ReservationTransactionsListResult": { + "description": "Result of listing reservation recommendations.", + "properties": { + "value": { + "description": "The list of reservation recommendations.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReservationTransaction" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ModernReservationTransactionsListResult": { + "description": "Result of listing reservation recommendations.", + "properties": { + "value": { + "description": "The list of reservation recommendations.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ModernReservationTransaction" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "TagsResult": { + "description": "A resource listing all tags.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagProperties", + "title": "Tag properties" + } + } + }, + "TagProperties": { + "description": "The properties of the tag.", + "properties": { + "tags": { + "description": "A list of Tag.", + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "previousLink": { + "description": "The link (url) to the previous page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Tag": { + "description": "The tag resource.", + "properties": { + "key": { + "description": "Tag key.", + "type": "string" + }, + "value": { + "description": "Tag values.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "BudgetsListResult": { + "description": "Result of listing budgets. It contains a list of available budgets in the scope provided.", + "properties": { + "value": { + "description": "The list of budgets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Budget" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Budget": { + "description": "A budget resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BudgetProperties", + "title": "Budget properties" + } + } + }, + "BudgetProperties": { + "description": "The properties of the budget.", + "properties": { + "category": { + "description": "The category of the budget, whether the budget tracks cost or usage.", + "type": "string", + "enum": [ + "Cost" + ], + "x-ms-enum": { + "name": "CategoryType", + "modelAsString": true + } + }, + "amount": { + "description": "The total amount of cost to track with the budget", + "type": "number", + "format": "decimal" + }, + "timeGrain": { + "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers", + "type": "string", + "enum": [ + "Monthly", + "Quarterly", + "Annually", + "BillingMonth", + "BillingQuarter", + "BillingAnnual" + ], + "x-ms-enum": { + "name": "TimeGrainType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", + "$ref": "#/definitions/BudgetTimePeriod" + }, + "filter": { + "description": "May be used to filter budgets by user-specified dimensions and/or tags.", + "type": "object", + "$ref": "#/definitions/BudgetFilter" + }, + "currentSpend": { + "description": "The current amount of cost which is being tracked for a budget.", + "$ref": "#/definitions/CurrentSpend", + "readOnly": true + }, + "notifications": { + "type": "object", + "description": "Dictionary of notifications associated with the budget. Budget can have up to five notifications.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/Notification" + }, + "maxItems": 5 + }, + "forecastSpend": { + "description": "The forecasted cost which is being tracked for a budget.", + "$ref": "#/definitions/ForecastSpend", + "readOnly": true + } + }, + "required": [ + "category", + "amount", + "timeGrain", + "timePeriod" + ] + }, + "BudgetTimePeriod": { + "description": "The start and end date for a budget.", + "properties": { + "startDate": { + "description": "The start date for the budget.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date for the budget. If not provided, we default this to 10 years from the start date.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "startDate" + ] + }, + "BudgetFilter": { + "description": "May be used to filter budgets by resource group, resource, or meter.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/BudgetFilterProperties" + }, + "x-ms-identifiers": [], + "minItems": 0 + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/BudgetComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/BudgetComparisonExpression" + } + } + }, + "BudgetFilterProperties": { + "description": "The Dimensions or Tags to filter a budget by.", + "properties": { + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/BudgetComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/BudgetComparisonExpression" + } + } + }, + "BudgetComparisonExpression": { + "description": "The comparison expression to be used in the budgets.", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "BudgetOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "CurrentSpend": { + "description": "The current amount of cost which is being tracked for a budget.", + "properties": { + "amount": { + "description": "The total amount of cost which is being tracked by the budget.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unit": { + "description": "The unit of measure for the budget amount.", + "type": "string", + "readOnly": true + } + } + }, + "ForecastSpend": { + "description": "The forecasted cost which is being tracked for a budget.", + "properties": { + "amount": { + "description": "The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unit": { + "description": "The unit of measure for the budget amount.", + "type": "string", + "readOnly": true + } + } + }, + "Notification": { + "description": "The notification associated with a budget.", + "properties": { + "enabled": { + "description": "The notification is enabled or not.", + "type": "boolean" + }, + "operator": { + "description": "The comparison operator.", + "type": "string", + "enum": [ + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true, + "values": [ + { + "value": "EqualTo", + "description": "Alert will be triggered if the evaluated cost is the same as threshold value. Note: It’s not recommended to use this OperatorType as there’s low chance of cost being exactly the same as threshold value, leading to missing of your alert. This OperatorType will be deprecated in future. ", + "name": "EqualTo" + }, + { + "value": "GreaterThan", + "description": "Alert will be triggered if the evaluated cost is greater than the threshold value. Note: This is the recommended OperatorType while configuring Budget Alert.", + "name": "GreaterThan" + }, + { + "value": "GreaterThanOrEqualTo", + "description": "Alert will be triggered if the evaluated cost is greater than or equal to the threshold value.", + "name": "GreaterThanOrEqualTo" + } + ] + } + }, + "threshold": { + "description": "Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.", + "type": "number", + "format": "decimal" + }, + "contactEmails": { + "description": "Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 50 + }, + "contactRoles": { + "description": "Contact roles to send the budget notification to when the threshold is exceeded.", + "type": "array", + "items": { + "type": "string" + } + }, + "contactGroups": { + "description": "Action groups to send the budget notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id. Only supported at Subscription or Resource Group scopes.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 50 + }, + "thresholdType": { + "description": "The type of threshold", + "type": "string", + "enum": [ + "Actual", + "Forecasted" + ], + "x-ms-enum": { + "name": "ThresholdType", + "modelAsString": true, + "values": [ + { + "value": "Actual", + "description": "Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget .", + "name": "Actual" + }, + { + "value": "Forecasted", + "description": "Forecasted costs budget alerts provide advanced notification that your spending trends are likely to exceed your allocated budget, as it relies on forecasted cost predictions.", + "name": "Forecasted" + } + ] + }, + "default": "Actual" + }, + "locale": { + "description": "Language in which the recipient will receive the notification", + "type": "string", + "enum": [ + "en-us", + "ja-jp", + "zh-cn", + "de-de", + "es-es", + "fr-fr", + "it-it", + "ko-kr", + "pt-br", + "ru-ru", + "zh-tw", + "cs-cz", + "pl-pl", + "tr-tr", + "da-dk", + "en-gb", + "hu-hu", + "nb-no", + "nl-nl", + "pt-pt", + "sv-se" + ], + "x-ms-enum": { + "name": "CultureCode", + "modelAsString": true + } + } + }, + "required": [ + "enabled", + "operator", + "threshold", + "contactEmails" + ] + }, + "PriceSheetResult": { + "description": "An pricesheet resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PriceSheetModel", + "title": "Price sheet properties" + } + } + }, + "PriceSheetModel": { + "description": "price sheet result. It contains the pricesheet associated with billing period", + "properties": { + "pricesheets": { + "description": "Price sheet", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PriceSheetProperties" + }, + "x-ms-identifiers": [ + "meterId" + ] + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "download": { + "description": "Pricesheet download details.", + "$ref": "#/definitions/MeterDetails", + "readOnly": true + } + } + }, + "DownloadProperties": { + "description": "The properties of the price sheet download.", + "properties": { + "downloadUrl": { + "description": "The link (url) to download the pricesheet.", + "type": "string", + "readOnly": true + }, + "validTill": { + "description": "Download link validity.", + "type": "string", + "readOnly": true + } + } + }, + "PriceSheetProperties": { + "description": "The properties of the price sheet.", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID)", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "meterDetails": { + "description": "The details about the meter. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/MeterDetails", + "readOnly": true + }, + "unitOfMeasure": { + "description": "Unit of measure", + "type": "string", + "readOnly": true + }, + "includedQuantity": { + "description": "Included quality for an offer", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "partNumber": { + "description": "Part Number", + "type": "string", + "readOnly": true + }, + "unitPrice": { + "description": "Unit Price", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currencyCode": { + "description": "Currency Code", + "type": "string", + "readOnly": true + }, + "offerId": { + "description": "Offer Id", + "type": "string", + "readOnly": true + }, + "savingsPlan": { + "description": "SavingsPlan Details", + "$ref": "#/definitions/SavingsPlan", + "readOnly": true + } + } + }, + "ManagementGroupAggregatedCostResult": { + "description": "A management group aggregated cost resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagementGroupAggregatedCostProperties", + "title": "Management Group Aggregated Cost properties" + } + } + }, + "ManagementGroupAggregatedCostProperties": { + "description": "The properties of the Management Group Aggregated Cost.", + "type": "object", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the aggregated cost belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "The start of the date time range covered by aggregated cost.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usageEnd": { + "description": "The end of the date time range covered by the aggregated cost.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "azureCharges": { + "description": "Azure Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "marketplaceCharges": { + "description": "Marketplace Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges Billed Separately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "children": { + "description": "Children of a management group", + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupAggregatedCostResult" + } + }, + "includedSubscriptions": { + "description": "List of subscription Guids included in the calculation of aggregated cost", + "type": "array", + "items": { + "type": "string" + } + }, + "excludedSubscriptions": { + "description": "List of subscription Guids excluded from the calculation of aggregated cost", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ChargesListResult": { + "description": "Result of listing charge summary.", + "properties": { + "value": { + "description": "The list of charge summary", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ChargeSummary" + } + } + } + }, + "ChargeSummary": { + "description": "A charge summary resource.", + "type": "object", + "discriminator": "kind", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "Specifies the kind of charge summary.", + "enum": [ + "legacy", + "modern" + ], + "x-ms-enum": { + "name": "ChargeSummaryKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ] + }, + "LegacyChargeSummary": { + "description": "Legacy charge summary.", + "type": "object", + "x-ms-discriminator-value": "legacy", + "properties": { + "properties": { + "description": "Properties for legacy charge summary", + "$ref": "#/definitions/LegacyChargeSummaryProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ChargeSummary" + } + ], + "required": [ + "properties" + ] + }, + "LegacyChargeSummaryProperties": { + "description": "The properties of legacy charge summary.", + "type": "object", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the charge belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "Usage start date.", + "type": "string", + "readOnly": true + }, + "usageEnd": { + "description": "Usage end date.", + "type": "string", + "readOnly": true + }, + "azureCharges": { + "description": "Azure Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges Billed separately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "azureMarketplaceCharges": { + "description": "Marketplace Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currency": { + "description": "Currency Code", + "type": "string", + "readOnly": true + } + } + }, + "ModernChargeSummary": { + "description": "Modern charge summary.", + "type": "object", + "x-ms-discriminator-value": "modern", + "properties": { + "properties": { + "description": "Properties for modern charge summary", + "$ref": "#/definitions/ModernChargeSummaryProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ChargeSummary" + } + ], + "required": [ + "properties" + ] + }, + "ModernChargeSummaryProperties": { + "description": "The properties of modern charge summary.", + "type": "object", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the charge belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "Usage start date.", + "type": "string", + "readOnly": true + }, + "usageEnd": { + "description": "Usage end date.", + "type": "string", + "readOnly": true + }, + "azureCharges": { + "description": "Azure Charges.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "chargesBilledSeparately": { + "description": "Charges Billed separately.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "marketplaceCharges": { + "description": "Marketplace Charges.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "billingAccountId": { + "description": "Billing Account Id", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "Billing Profile Id", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "Invoice Section Id", + "type": "string", + "readOnly": true + }, + "customerId": { + "description": "Customer Id", + "type": "string", + "readOnly": true + }, + "isInvoiced": { + "description": "Is charge Invoiced", + "type": "boolean", + "readOnly": true + }, + "subscriptionId": { + "description": "Subscription guid.", + "type": "string", + "readOnly": true + } + } + }, + "MeterDetailsResponse": { + "description": "The properties of the meter detail.", + "properties": { + "meterName": { + "description": "The name of the meter, within the given meter category", + "type": "string", + "readOnly": true + }, + "meterCategory": { + "description": "The category of the meter, for example, 'Cloud services', 'Networking', etc..", + "type": "string", + "readOnly": true + }, + "meterSubCategory": { + "description": "The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..", + "type": "string", + "readOnly": true + }, + "unitOfMeasure": { + "description": "The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.", + "type": "string", + "readOnly": true + }, + "serviceFamily": { + "description": "The service family.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "HighCasedErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "HighCasedErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/HighCasedErrorDetails" + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header. \n\n * 504 Gateway Timeout - Service timed out while processing the request. Reduce the date range in the request, if possible.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "Operation": { + "description": "A Consumption REST API operation.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Operation Id." + }, + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Consumption.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: UsageDetail, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Description of the operation.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "OperationListResult": { + "description": "Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of consumption operations supported by the Microsoft.Consumption resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Events": { + "description": "Result of listing event summary.", + "properties": { + "value": { + "description": "The list of event summary.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EventSummary" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EventSummary": { + "description": "An event summary resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventProperties", + "title": "Event summary properties" + } + } + }, + "EventProperties": { + "description": "The event properties.", + "properties": { + "transactionDate": { + "description": "The date of the event.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "description": { + "description": "The description of the event.", + "type": "string", + "readOnly": true + }, + "newCredit": { + "description": "The amount of new credit or commitment for NewCredit or SettleCharges event.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "adjustments": { + "description": "The amount of balance adjustment. The property is not available for ConsumptionCommitment lots.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "creditExpired": { + "description": "The amount of expired credit or commitment for NewCredit or SettleCharges event.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "charges": { + "description": "The amount of charges for events of type SettleCharges and PendingEligibleCharges. ", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "closedBalance": { + "description": "The balance after the event, Note: This will not be returned for Contributor Organization Type in Multi-Entity consumption commitment", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "billingAccountId": { + "description": "Identifier of the billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountDisplayName": { + "description": "Name of the billing account.", + "type": "string", + "readOnly": true + }, + "eventType": { + "description": "Identifies the type of the event.", + "type": "string", + "enum": [ + "SettledCharges", + "PendingCharges", + "PendingAdjustments", + "PendingNewCredit", + "PendingExpiredCredit", + "UnKnown", + "NewCredit", + "CreditExpired" + ], + "x-ms-enum": { + "name": "EventType", + "modelAsString": true + } + }, + "invoiceNumber": { + "description": "The number which uniquely identifies the invoice on which the event was billed. This will be empty for unbilled events.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID that uniquely identifies the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement. ", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The display name of the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement.", + "type": "string", + "readOnly": true + }, + "lotId": { + "description": "The ID that uniquely identifies the lot for which the event happened.", + "type": "string", + "readOnly": true + }, + "lotSource": { + "description": "Identifies the source of the lot for which the event happened. ", + "type": "string", + "readOnly": true + }, + "canceledCredit": { + "description": "Amount of canceled credit.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "creditCurrency": { + "description": "The credit currency of the event.", + "type": "string", + "readOnly": true + }, + "billingCurrency": { + "description": "The billing currency of the event.", + "type": "string", + "readOnly": true + }, + "reseller": { + "description": "The reseller of the event.", + "readOnly": true, + "$ref": "#/definitions/Reseller" + }, + "creditExpiredInBillingCurrency": { + "description": "The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "newCreditInBillingCurrency": { + "description": "The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "adjustmentsInBillingCurrency": { + "description": "The amount of balance adjustment in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "chargesInBillingCurrency": { + "description": "The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "closedBalanceInBillingCurrency": { + "description": "The balance in billing currency after the event, Note: This will not be returned for Contributor Organization Type in Multi-Entity consumption commitment", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "isEstimatedBalance": { + "description": "If true, the listed details are based on an estimation and it will be subjected to change.", + "type": "boolean", + "readOnly": true + }, + "eTag": { + "readOnly": true, + "type": "string", + "description": "The eTag for the resource." + } + } + }, + "Lots": { + "description": "Result of listing lot summary.", + "properties": { + "value": { + "description": "The list of lot summary.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/LotSummary" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "LotSummary": { + "description": "A lot summary resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LotProperties", + "title": "Lot summary properties" + } + } + }, + "LotProperties": { + "description": "The lot properties.", + "properties": { + "originalAmount": { + "description": "The original amount of a lot, Note: This will not be returned for Contributor Organization Type in Multi-Entity consumption commitment", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "closedBalance": { + "description": "The balance as of the last invoice.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "source": { + "description": "The source of the lot.", + "type": "string", + "enum": [ + "PurchasedCredit", + "PromotionalCredit", + "ConsumptionCommitment" + ], + "x-ms-enum": { + "name": "LotSource", + "modelAsString": true + }, + "readOnly": true + }, + "startDate": { + "description": "The date when the lot became effective.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "expirationDate": { + "description": "The expiration date of a lot.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "poNumber": { + "description": "The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots.", + "type": "string", + "readOnly": true + }, + "purchasedDate": { + "description": "The date when the lot was added.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "The status of the lot.", + "type": "string", + "enum": [ + "None", + "Active", + "Inactive", + "Expired", + "Complete", + "Canceled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "creditCurrency": { + "description": "The currency of the lot.", + "type": "string", + "readOnly": true + }, + "billingCurrency": { + "description": "The billing currency of the lot.", + "type": "string", + "readOnly": true + }, + "originalAmountInBillingCurrency": { + "description": "The original amount of a lot in billing currency, Note: This will not be returned for Contributor Organization Type in Multi-Entity consumption commitment", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "closedBalanceInBillingCurrency": { + "description": "The balance as of the last invoice in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "reseller": { + "description": "The reseller of the lot.", + "readOnly": true, + "$ref": "#/definitions/Reseller" + }, + "isEstimatedBalance": { + "description": "If true, the listed details are based on an estimation and it will be subjected to change.", + "type": "boolean", + "readOnly": true + }, + "eTag": { + "readOnly": true, + "type": "string", + "description": "The eTag for the resource." + }, + "OrganizationType": { + "description": "The organization type of the lot.", + "type": "string", + "enum": [ + "Primary", + "Contributor" + ], + "readOnly": true, + "x-ms-enum": { + "name": "OrganizationType", + "modelAsString": true, + "values": [ + { + "value": "Primary", + "description": "Primary organization type for Multi-Entity consumption commitment.", + "name": "PrimaryOrganizationType" + }, + { + "value": "Contributor", + "description": "Contributor organization type for Multi-Entity consumption commitment.", + "name": "ContributorOrganizationType" + } + ] + } + }, + "usedAmount": { + "description": "Amount consumed from the commitment.", + "readOnly": true, + "$ref": "#/definitions/amount" + } + } + }, + "CreditSummary": { + "description": "A credit summary resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CreditSummaryProperties", + "title": "Credit summary properties" + } + } + }, + "CreditSummaryProperties": { + "description": "The properties of the credit summary.", + "type": "object", + "properties": { + "balanceSummary": { + "description": "Summary of balances associated with this credit summary.", + "readOnly": true, + "$ref": "#/definitions/CreditBalanceSummary" + }, + "pendingCreditAdjustments": { + "description": "Pending credit adjustments.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "expiredCredit": { + "description": "Expired credit.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "pendingEligibleCharges": { + "description": "Pending eligible charges.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "creditCurrency": { + "description": "The credit currency.", + "type": "string", + "readOnly": true + }, + "billingCurrency": { + "description": "The billing currency.", + "type": "string", + "readOnly": true + }, + "reseller": { + "description": "Credit's reseller.", + "readOnly": true, + "$ref": "#/definitions/Reseller" + }, + "isEstimatedBalance": { + "description": "If true, the listed details are based on an estimation and it will be subjected to change.", + "type": "boolean", + "readOnly": true + }, + "eTag": { + "readOnly": true, + "type": "string", + "description": "The eTag for the resource." + } + } + }, + "CreditBalanceSummary": { + "description": "Summary of credit balances.", + "properties": { + "estimatedBalance": { + "description": "Estimated balance.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "currentBalance": { + "description": "Current balance.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "estimatedBalanceInBillingCurrency": { + "description": "Estimated balance in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + } + } + }, + "amount": { + "description": "The amount plus currency .", + "properties": { + "currency": { + "readOnly": true, + "type": "string", + "description": "Amount currency." + }, + "value": { + "readOnly": true, + "type": "number", + "format": "decimal", + "description": "Amount." + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The full qualified ARM ID of an event." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The ID that uniquely identifies an event. " + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The etag for the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ReservationTransactionResource": { + "description": "The Resource model definition.", + "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." + }, + "tags": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ResourceAttributes": { + "description": "The Resource model definition.", + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + }, + "sku": { + "readOnly": true, + "type": "string", + "description": "Resource sku" + } + } + }, + "ProxyResource": { + "description": "The Resource model definition.", + "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." + }, + "eTag": { + "type": "string", + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." + } + }, + "x-ms-azure-resource": true + }, + "AmountWithExchangeRate": { + "description": "The amount with exchange rate.", + "allOf": [ + { + "$ref": "#/definitions/amount" + } + ], + "properties": { + "exchangeRate": { + "description": "The exchange rate.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "exchangeRateMonth": { + "description": "The exchange rate month.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "Reseller": { + "description": "The reseller properties.", + "type": "object", + "properties": { + "resellerId": { + "description": "The reseller property ID.", + "type": "string", + "readOnly": true + }, + "resellerDescription": { + "description": "The reseller property description.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "scopeChargesParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with charges operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. For department and enrollment accounts, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeUsageDetailsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeMarketplaceParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with marketplace operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeBudgetParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeTagsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with tags operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope..", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeReservationsSummariesParameter": { + "name": "resourceScope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with reservations summaries operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern). ", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeReservationDetailsParameter": { + "name": "resourceScope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with reservations details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern). ", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeReservationRecommendationsParameter": { + "name": "resourceScope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with reservation recommendations operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeReservationRecommendationDetailsParameter": { + "name": "resourceScope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with reservation recommendation details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeReservationTransactionsParameter": { + "name": "resourceScope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with reservation transactions operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount/Enrollment scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2023-03-01." + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "customerIdParameter": { + "name": "customerId", + "in": "path", + "description": "Customer ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "EnrollmentAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure Resource Group Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "budgetNameParameter": { + "name": "budgetName", + "in": "path", + "description": "Budget Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingPeriodNameParameter": { + "name": "billingPeriodName", + "in": "path", + "description": "Billing Period Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "reservationOrderIdParameter": { + "name": "reservationOrderId", + "in": "path", + "description": "Order Id of the reservation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "reservationIdParameter": { + "name": "reservationId", + "in": "path", + "description": "Id of the reservation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "grainParameter": { + "name": "grain", + "description": "Can be daily or monthly", + "x-ms-parameter-location": "method", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "daily", + "monthly" + ], + "x-ms-enum": { + "name": "datagrain", + "modelAsString": true, + "values": [ + { + "value": "daily", + "description": "Daily grain of data", + "name": "DailyGrain" + }, + { + "value": "monthly", + "description": "Monthly grain of data", + "name": "MonthlyGrain" + } + ] + } + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "Azure Management Group ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingProfileIdParameter": { + "name": "billingProfileId", + "in": "path", + "description": "Azure Billing Profile ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "invoiceSectionIdParameter": { + "name": "invoiceSectionId", + "in": "path", + "description": "Azure Invoice Section ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "startDateParameter": { + "name": "startDate", + "in": "query", + "description": "Start date", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "endDateParameter": { + "name": "endDate", + "in": "query", + "description": "End date", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "metricParameter": { + "name": "metric", + "in": "query", + "description": "Allows to select different type of cost/usage records.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "actualcost", + "amortizedcost", + "usage" + ], + "x-ms-enum": { + "name": "metrictype", + "modelAsString": true, + "values": [ + { + "value": "actualcost", + "description": "Actual cost data.", + "name": "ActualCostMetricType" + }, + { + "value": "amortizedcost", + "description": "Amortized cost data.", + "name": "AmortizedCostMetricType" + }, + { + "value": "usage", + "description": "Usage data.", + "name": "UsageMetricType" + } + ] + } + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "description": "May be used to filter reservationRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Single'; properties/resourceType with allowed values ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple'] and default value 'VirtualMachines'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last7Days'.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "recommendationDetailsFilterParameter": { + "name": "$filter", + "in": "query", + "description": "Used to filter reservation recommendation details by: properties/subscriptionId can be specified for billing account and billing profile paths.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "termParameter": { + "description": "Specify length of reservation recommendation term.", + "type": "string", + "in": "query", + "required": true, + "name": "term", + "x-ms-parameter-location": "method", + "enum": [ + "P1M", + "P1Y", + "P3Y" + ], + "x-ms-enum": { + "name": "term", + "modelAsString": true, + "values": [ + { + "value": "P1M", + "description": "1 month reservation term", + "name": "P1M" + }, + { + "value": "P1Y", + "description": "1 year reservation term", + "name": "P1Y" + }, + { + "value": "P3Y", + "description": "3 year reservation term", + "name": "P3Y" + } + ] + } + }, + "regionParameter": { + "name": "region", + "in": "query", + "description": "Used to select the region the recommendation should be generated for.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "lookBackPeriodParameter": { + "name": "lookBackPeriod", + "in": "query", + "description": "Filter the time period on which reservation recommendation results are based.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "Last7Days", + "Last30Days", + "Last60Days" + ], + "x-ms-enum": { + "name": "lookBackPeriod", + "modelAsString": true, + "values": [ + { + "value": "Last7Days", + "description": "Use 7 days of data for recommendations", + "name": "Last07Days" + }, + { + "value": "Last30Days", + "description": "Use 30 days of data for recommendations", + "name": "Last30Days" + }, + { + "value": "Last60Days", + "description": "Use 60 days of data for recommendations", + "name": "Last60Days" + } + ] + } + }, + "productParameter": { + "name": "product", + "in": "query", + "description": "Filter the products for which reservation recommendation results are generated. Examples: Standard_DS1_v2 (for VM), Premium_SSD_Managed_Disks_P30 (for Managed Disks)", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "scopeParameter": { + "description": "Scope of the reservation.", + "type": "string", + "name": "scope", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "enum": [ + "Single", + "Shared" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "useMarkupIfPartnerParameter": { + "name": "useMarkupIfPartner", + "in": "query", + "description": "Applies mark up to the transactions if the caller is a partner.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "previewMarkupPercentage": { + "name": "previewMarkupPercentage", + "in": "query", + "description": "Preview markup percentage to be applied.", + "required": false, + "type": "number", + "format": "decimal", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption_pricesheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption_pricesheet.json new file mode 100644 index 000000000000..4a15309c55b2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/consumption_pricesheet.json @@ -0,0 +1,158 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-01", + "title": "ConsumptionManagementClient", + "description": "Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions." + }, + "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.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/download": { + "post": { + "tags": [ + "PriceSheet" + ], + "operationId": "PriceSheet_DownloadByBillingAccountPeriod", + "description": "Generates the pricesheet for the provided billing period asynchronously based on the enrollment id", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "EAPriceSheetForBillingPeriod": { + "$ref": "./examples/EAPriceSheetForBillingPeriod.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int64" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationStatus": { + "description": "The status of the long running operation.", + "type": "object", + "properties": { + "status": { + "description": "The status of the long running operation.", + "type": "string", + "enum": [ + "Running", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatusType", + "modelAsString": true + } + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the resource generated.", + "$ref": "#/definitions/PricesheetDownloadProperties" + } + } + }, + "PricesheetDownloadProperties": { + "description": "The properties of the price sheet download.", + "type": "object", + "properties": { + "downloadUrl": { + "description": "The link (url) to download the pricesheet.", + "type": "string", + "readOnly": true + }, + "validTill": { + "description": "Download link validity.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + } + }, + "parameters": { + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingPeriodNameParameter": { + "name": "billingPeriodName", + "in": "path", + "description": "Billing Period Name.", + "required": true, + "type": "string", + "pattern": "^[0-9]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroup.json new file mode 100644 index 000000000000..367757e067ef --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "managementGroupId": "managementGroupForTest" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1", + "name": "aggregatedcostId1", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "1caaa5a3-2b66-438e-8ab4-bce37d518c5d" + ], + "excludedSubscriptions": [], + "usageStart": "2023-03-01T00:00:00.0000000Z", + "usageEnd": "2024-08-01T00:00:00.0000000Z", + "azureCharges": 250.9876, + "marketplaceCharges": 150.786, + "chargesBilledSeparately": 120.345, + "currency": "USD", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2", + "name": "aggregatedcostId2", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "c349567d-c83a-48c9-ab0e-578c69dc97a4" + ], + "excludedSubscriptions": [], + "usageStart": "2023-03-01T00:00:00.0000000Z", + "usageEnd": "2024-08-01T00:00:00.0000000Z", + "azureCharges": 150.0, + "marketplaceCharges": 50.786, + "chargesBilledSeparately": 30.345, + "currency": "USD", + "children": [] + } + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroupFilterByDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroupFilterByDate.json new file mode 100644 index 000000000000..5dacf90be7f6 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostByManagementGroupFilterByDate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "managementGroupId": "managementGroupForTest", + "$filter": "usageStart ge '2018-08-15' and properties/usageStart le '2018-08-31'" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1", + "name": "aggregatedcostId1", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "1caaa5a3-2b66-438e-8ab4-bce37d518c5d" + ], + "excludedSubscriptions": [], + "usageStart": "2018-08-15T00:00:00.0000000Z", + "usageEnd": "2018-08-31T00:00:00.0000000Z", + "azureCharges": 150.9876, + "marketplaceCharges": 80.786, + "chargesBilledSeparately": 90.345, + "currency": "USD", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2", + "name": "aggregatedcostId2", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "c349567d-c83a-48c9-ab0e-578c69dc97a4" + ], + "excludedSubscriptions": [], + "usageStart": "2018-08-15T00:00:00.0000000Z", + "usageEnd": "2018-08-31T00:00:00.0000000Z", + "azureCharges": 50.0, + "marketplaceCharges": 10.786, + "chargesBilledSeparately": 30.345, + "currency": "USD", + "children": [] + } + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json new file mode 100644 index 000000000000..84234f8b3639 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201807" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1", + "name": "aggregatedcostId1", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "usageStart": "2018-07-01T00:00:00.0000000Z", + "usageEnd": "2018-07-31T00:00:00.0000000Z", + "azureCharges": 250.9876, + "marketplaceCharges": 150.786, + "chargesBilledSeparately": 120.345, + "currency": "USD", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2", + "name": "aggregatedcostId2", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "usageStart": "2018-07-01T00:00:00.0000000Z", + "usageEnd": "2018-07-31T00:00:00.0000000Z", + "azureCharges": 150.0, + "marketplaceCharges": 50.786, + "chargesBilledSeparately": 30.345, + "currency": "USD", + "children": [] + } + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccount.json new file mode 100644 index 000000000000..201dd66a5bb3 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccount.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1", + "name": "balanceId1", + "type": "Microsoft.Consumption/balances", + "properties": { + "currency": "USD ", + "beginningBalance": 3396469.19, + "endingBalance": 2922371.02, + "newPurchases": 0, + "adjustments": 0, + "utilized": 474098.17, + "serviceOverage": 0, + "chargesBilledSeparately": 0, + "totalOverage": 0, + "totalUsage": 474098.17, + "azureMarketplaceServiceCharges": 609.82, + "billingFrequency": "Month", + "priceHidden": false, + "overageRefund": 2012.61, + "newPurchasesDetails": [ + { + "name": "Promo Purchase", + "value": 1 + } + ], + "adjustmentDetails": [ + { + "name": "Promo Credit", + "value": 1.1 + }, + { + "name": "SIE Credit", + "value": 1.0 + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccountForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccountForBillingPeriod.json new file mode 100644 index 000000000000..576168863845 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BalancesByBillingAccountForBillingPeriod.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1", + "name": "balanceId1", + "type": "Microsoft.Consumption/balances", + "properties": { + "currency": "USD ", + "beginningBalance": 3396469.19, + "endingBalance": 2922371.02, + "newPurchases": 0, + "adjustments": 0, + "utilized": 474098.17, + "serviceOverage": 0, + "chargesBilledSeparately": 0, + "totalOverage": 0, + "totalUsage": 474098.17, + "azureMarketplaceServiceCharges": 609.82, + "billingFrequency": "Month", + "priceHidden": false, + "overageRefund": 2012.61, + "newPurchasesDetails": [ + { + "name": "Promo Purchase", + "value": 1 + } + ], + "adjustmentDetails": [ + { + "name": "Promo Credit", + "value": 1.1 + }, + { + "name": "SIE Credit", + "value": 1.0 + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Budget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Budget.json new file mode 100644 index 000000000000..371964585cda --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Budget.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BudgetsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BudgetsList.json new file mode 100644 index 000000000000..11c7fc7d76cc --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/BudgetsList.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ] + }, + "thresholdType": "Actual" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 600.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByDepartment.json new file mode 100644 index 000000000000..164fdb02e9c6 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByDepartment.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingPeriodName": "201804", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234/departments/42425" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/departments/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "legacy", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "azureMarketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByEnrollmentAccount.json new file mode 100644 index 000000000000..64846a678dd2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesForBillingPeriodByEnrollmentAccount.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingPeriodName": "201804", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "legacy", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "azureMarketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccount.json new file mode 100644 index 000000000000..90ba30733bff --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccount.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "startDate": "2019-09-01", + "endDate": "2019-10-31", + "scope": "providers/Microsoft.Billing/billingAccounts/1234:56789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201910", + "usageStart": "2019-09-01", + "usageEnd": "2019-10-31", + "azureCharges": { + "currency": "USD", + "value": 0.0 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 265.09 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 0.0 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": null, + "invoiceSectionId": null + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByBillingProfileId.json new file mode 100644 index 000000000000..9f0db3a269f1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByBillingProfileId.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/billingAccounts/1234:56789", + "startDate": "2019-09-01", + "endDate": "2019-09-30", + "$apply": "groupby((properties/billingProfileId))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/123456/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/123456" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789/billingProfiles/42425/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByCustomerId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByCustomerId.json new file mode 100644 index 000000000000..90ec52947e51 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByCustomerId.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/billingAccounts/1234:56789", + "startDate": "2019-09-01", + "endDate": "2019-09-30", + "$apply": "groupby((properties/customerId))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/customers/67890/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "customerId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/customers/67890", + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/invoiceSections/67890" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789/customers/123456/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "customerId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/customers/123456", + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/invoiceSections/67890" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByInvoiceSectionId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByInvoiceSectionId.json new file mode 100644 index 000000000000..143537215887 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingAccountGroupByInvoiceSectionId.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "startDate": "2019-09-01", + "endDate": "2019-09-30", + "$apply": "groupby((properties/invoiceSectionId))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425/invoiceSections/4567/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/invoiceSections/4567" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789//billingProfiles/42425/invoiceSections/67890/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/invoiceSections/67890" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfile.json new file mode 100644 index 000000000000..5bd5eb6281b9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfile.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234:56789/billingProfiles/2460" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/2460/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201910", + "usageStart": "2023-03-01", + "usageEnd": "2023-05-31", + "azureCharges": { + "currency": "USD", + "value": 0.0 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 265.09 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 0.0 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/2460", + "invoiceSectionId": null + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileGroupByInvoiceSectionId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileGroupByInvoiceSectionId.json new file mode 100644 index 000000000000..143537215887 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileGroupByInvoiceSectionId.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "startDate": "2019-09-01", + "endDate": "2019-09-30", + "$apply": "groupby((properties/invoiceSectionId))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425/invoiceSections/4567/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/invoiceSections/4567" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789//billingProfiles/42425/invoiceSections/67890/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/invoiceSections/67890" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileInvoiceSection.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileInvoiceSection.json new file mode 100644 index 000000000000..d7ec812fdf28 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernBillingProfileInvoiceSection.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "startDate": "2019-09-01", + "endDate": "2019-10-31", + "scope": "providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425/invoiceSections/67890" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425/invoiceSections/67890/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201909", + "usageStart": "2019-09-01", + "usageEnd": "2019-09-30", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425/invoiceSections/4567" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425/invoiceSections/67890/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201910", + "usageStart": "2019-09-01", + "usageEnd": "2019-10-31", + "azureCharges": { + "currency": "USD", + "value": 5000.00 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 60.90 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 100.00 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/42425/invoiceSections/4567" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernCustomer.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernCustomer.json new file mode 100644 index 000000000000..939de9a3ff60 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernCustomer.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234:56789/customers/67890" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/customers/67890/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201910", + "usageStart": "2023-03-01", + "usageEnd": "2023-05-31", + "azureCharges": { + "currency": "USD", + "value": 0.0 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 265.09 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 0.0 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": null, + "invoiceSectionId": null + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernInvoiceSectionId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernInvoiceSectionId.json new file mode 100644 index 000000000000..7eff8c6c8266 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListByModernInvoiceSectionId.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234:56789/invoiceSections/97531" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/2460/invoiceSections/97531/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "modern", + "properties": { + "isInvoiced": false, + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Billing/billingPeriods/201910", + "usageStart": "2023-03-01", + "usageEnd": "2023-05-31", + "azureCharges": { + "currency": "USD", + "value": 12.0 + }, + "chargesBilledSeparately": { + "currency": "USD", + "value": 0.0 + }, + "marketplaceCharges": { + "currency": "USD", + "value": 0.0 + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/1234:56789", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/2460", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/1234:56789/billingProfiles/2460/invoiceSections/97531" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForDepartmentFilterByStartEndDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForDepartmentFilterByStartEndDate.json new file mode 100644 index 000000000000..21fe6772c2a8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForDepartmentFilterByStartEndDate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234/departments/42425", + "$filter": "usageStart eq '2018-04-01' AND usageEnd eq '2018-05-30'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/departments/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "legacy", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "azureMarketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json new file mode 100644 index 000000000000..04a85b864ee9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "kind": "legacy", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "azureMarketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreateOrUpdateBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreateOrUpdateBudget.json new file mode 100644 index 000000000000..607985569614 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreateOrUpdateBudget.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreditSummaryByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreditSummaryByBillingProfile.json new file mode 100644 index 000000000000..6bdf36228774 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/CreditSummaryByBillingProfile.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "billingProfileId": "2468" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/credits/balanceSummary1", + "name": "balanceSummary1", + "type": "Microsoft.Consumption/credits/balanceSummary", + "properties": { + "creditCurrency": "USD", + "billingCurrency": "USD", + "balanceSummary": { + "estimatedBalance": { + "currency": "USD", + "value": 600.00 + }, + "currentBalance": { + "currency": "USD", + "value": 100.00 + } + }, + "pendingCreditAdjustments": { + "currency": "USD", + "value": 500.00 + }, + "expiredCredit": { + "currency": "USD", + "value": 0.00 + }, + "pendingEligibleCharges": { + "currency": "USD", + "value": 0.00 + }, + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information." + }, + "isEstimatedBalance": false + } + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/DeleteBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/DeleteBudget.json new file mode 100644 index 000000000000..1cc022fc99d2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/DeleteBudget.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EAPriceSheetForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EAPriceSheetForBillingPeriod.json new file mode 100644 index 000000000000..93d32abba445 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EAPriceSheetForBillingPeriod.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "0000000", + "billingPeriodName": "202305" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/0000000/providers/Microsoft.Consumption/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-03-01", + "Retry-After": 10 + } + }, + "200": { + "body": { + "status": "Completed", + "properties": { + "downloadUrl": "https://xxxxxx.blob.core.windows.net/armpricesheetreportdownloadcontainer/20230510/00000000-0000-0000-0000-000000000000", + "validTill": "2023-05-11T05:12:50.4266333Z" + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Contributor.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Contributor.json new file mode 100644 index 000000000000..e25949a936a8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Contributor.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId1", + "name": "eventId1", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "ConsumptionCommitment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "New MACC Added", + "charges": { + "currency": "USD", + "value": 500 + }, + "newCredit": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "NewCredit" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId2", + "name": "eventId2", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "AzurePrepayment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/7004bc39-974d-482e-8e45-caf91dba0870", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "Balance after invoice 3304", + "charges": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "SettledCharges" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Primary.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Primary.json new file mode 100644 index 000000000000..d8fd5388611f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount-Primary.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId1", + "name": "eventId1", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "ConsumptionCommitment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "New MACC Added", + "billingAccountId": "1234:5678", + "billingAccountDisplayName": "TestBillingAccount", + "charges": { + "currency": "USD", + "value": 500 + }, + "newCredit": { + "currency": "USD", + "value": 500 + }, + "closedBalance": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "NewCredit" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId2", + "name": "eventId2", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "AzurePrepayment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/7004bc39-974d-482e-8e45-caf91dba0870", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "Balance after invoice 3304", + "billingAccountId": "1234:5678", + "billingAccountDisplayName": "TestBillingAccount", + "charges": { + "currency": "USD", + "value": 500 + }, + "closedBalance": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "SettledCharges" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount.json new file mode 100644 index 000000000000..04f1ec5079e7 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccount.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId1", + "name": "eventId1", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "ConsumptionCommitment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "New MACC Added", + "billingAccountId": "1234:5678", + "billingAccountDisplayName": "TestBillingAccount", + "charges": { + "currency": "USD", + "value": 500 + }, + "newCredit": { + "currency": "USD", + "value": 500 + }, + "closedBalance": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "NewCredit" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId2", + "name": "eventId2", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "AzurePrepayment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/7004bc39-974d-482e-8e45-caf91dba0870", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "Balance after invoice 3304", + "charges": { + "currency": "USD", + "value": 500 + }, + "closedBalance": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "SettledCharges" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Contributor.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Contributor.json new file mode 100644 index 000000000000..b729c32a660f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Contributor.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "$filter": "lotid eq 'G202001083926600XXXXX' AND lotsource eq 'consumptioncommitment'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId1", + "name": "eventId1", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "ConsumptionCommitment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "MACC Canceled", + "canceledCredit": { + "currency": "USD", + "value": 200 + }, + "invoiceNumber": "3304", + "eventType": "CanceledCredit" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Primary.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Primary.json new file mode 100644 index 000000000000..cdba5cf927f0 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters-Primary.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "$filter": "lotid eq 'G202001083926600XXXXX' AND lotsource eq 'consumptioncommitment'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId1", + "name": "eventId1", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "ConsumptionCommitment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "MACC Canceled", + "billingAccountId": "1234:5678", + "billingAccountDisplayName": "TestBillingAccount", + "canceledCredit": { + "currency": "USD", + "value": 200 + }, + "closedBalance": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "CanceledCredit" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters.json new file mode 100644 index 000000000000..cdba5cf927f0 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsGetByBillingAccountWithFilters.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "$filter": "lotid eq 'G202001083926600XXXXX' AND lotsource eq 'consumptioncommitment'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId1", + "name": "eventId1", + "type": "Microsoft.Consumption/events", + "properties": { + "lotSource": "ConsumptionCommitment", + "lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", + "billingProfileDisplayName": "Contoso Operations Billing", + "transactionDate": "2019-07-01T00:00:00Z", + "description": "MACC Canceled", + "billingAccountId": "1234:5678", + "billingAccountDisplayName": "TestBillingAccount", + "canceledCredit": { + "currency": "USD", + "value": 200 + }, + "closedBalance": { + "currency": "USD", + "value": 500 + }, + "invoiceNumber": "3304", + "eventType": "CanceledCredit" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsListByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsListByBillingProfile.json new file mode 100644 index 000000000000..758e26455572 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/EventsListByBillingProfile.json @@ -0,0 +1,261 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "billingProfileId": "4268", + "startDate": "2019-09-01", + "endDate": "2019-10-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event1", + "name": "event1", + "type": "Microsoft.Consumption/events", + "properties": { + "transactionDate": "2019-07-01T00:00:00Z", + "description": "Settled invoice #312033", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", + "newCredit": { + "currency": "USD", + "value": 0.00 + }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "adjustments": { + "currency": "USD", + "value": 0.00 + }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "creditExpired": { + "currency": "USD", + "value": 0.00 + }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "charges": { + "currency": "USD", + "value": 500.00 + }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "closedBalance": { + "currency": "USD", + "value": 500.00 + }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "eventType": "SettledCharges", + "invoiceNumber": "3301", + "isEstimatedBalance": false + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event2", + "name": "event2", + "type": "Microsoft.Consumption/events", + "properties": { + "transactionDate": "2019-08-01T00:00:00Z", + "description": "New credits added", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", + "newCredit": { + "currency": "USD", + "value": 400.00 + }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "canceledCredit": { + "currency": "USD", + "value": 5000 + }, + "adjustments": { + "currency": "USD", + "value": 0.00 + }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "creditExpired": { + "currency": "USD", + "value": 0.00 + }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "charges": { + "currency": "USD", + "value": 0.00 + }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "closedBalance": { + "currency": "USD", + "value": 900.00 + }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "eventType": "NewCredit", + "invoiceNumber": "3302", + "isEstimatedBalance": false + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event3", + "name": "event3", + "type": "Microsoft.Consumption/events", + "properties": { + "transactionDate": "2019-09-01T00:00:00Z", + "description": "Credits Expired", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", + "newCredit": { + "currency": "USD", + "value": 0.00 + }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "canceledCredit": { + "currency": "USD", + "value": 5000 + }, + "adjustments": { + "currency": "USD", + "value": 0.00 + }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "creditExpired": { + "currency": "USD", + "value": 300.00 + }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "charges": { + "currency": "USD", + "value": 0.00 + }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "closedBalance": { + "currency": "USD", + "value": 600.00 + }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "eventType": "ExpiredCredit", + "invoiceNumber": "", + "isEstimatedBalance": false + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event4", + "name": "event4", + "type": "Microsoft.Consumption/events", + "properties": { + "transactionDate": "2019-10-01T00:00:00Z", + "description": "Settled invoice #212033", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", + "newCredit": { + "currency": "USD", + "value": 300.00 + }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "canceledCredit": { + "currency": "USD", + "value": 5000 + }, + "adjustments": { + "currency": "USD", + "value": -200.00 + }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "creditExpired": { + "currency": "USD", + "value": 100.00 + }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "charges": { + "currency": "USD", + "value": 300.00 + }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "closedBalance": { + "currency": "USD", + "value": 700.00 + }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "eventType": "SettledCharges", + "invoiceNumber": "3303", + "isEstimatedBalance": false + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Contributor.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Contributor.json new file mode 100644 index 000000000000..be7e88e18357 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Contributor.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "usedAmount": { + "currency": "USD", + "value": 550.00 + }, + "OrganizationType": "Contributor", + "source": "ConsumptionCommitment", + "startDate": "2019-10-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "purchasedDate": "2019-09-01T00:00:00Z", + "status": "Active" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Primary.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Primary.json new file mode 100644 index 000000000000..cea6cf62e088 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount-Primary.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 5000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 60.90 + }, + "usedAmount": { + "currency": "USD", + "value": 550.00 + }, + "OrganizationType": "Primary", + "source": "ConsumptionCommitment", + "startDate": "2019-10-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "purchasedDate": "2019-09-01T00:00:00Z", + "status": "Active" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount.json new file mode 100644 index 000000000000..e1b8cdaf7ca8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccount.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 5000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 60.90 + }, + "source": "ConsumptionCommitment", + "startDate": "2019-10-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "purchasedDate": "2019-09-01T00:00:00Z", + "status": "Active" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot2", + "name": "lot2", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 6000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 80.90 + }, + "source": "ConsumptionCommitment", + "startDate": "2019-11-01T00:00:00Z", + "expirationDate": "2019-12-31T00:00:00Z", + "purchasedDate": "2019-09-01T00:00:00Z", + "status": "Expired" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Contributor.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Contributor.json new file mode 100644 index 000000000000..4189731de3df --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Contributor.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "$filter": "status eq 'active' AND source eq 'consumptioncommitment'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "usedAmount": { + "currency": "USD", + "value": 550.00 + }, + "OrganizationType": "Contributor", + "source": "ConsumptionCommitment", + "startDate": "2019-10-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "purchasedDate": "2019-09-01T00:00:00Z", + "status": "Active" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Primary.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Primary.json new file mode 100644 index 000000000000..2d7734126a38 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters-Primary.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "$filter": "status eq 'active' AND source eq 'consumptioncommitment'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 5000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 60.90 + }, + "usedAmount": { + "currency": "USD", + "value": 550.00 + }, + "OrganizationType": "Primary", + "source": "ConsumptionCommitment", + "startDate": "2019-10-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "purchasedDate": "2019-09-01T00:00:00Z", + "status": "Active" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters.json new file mode 100644 index 000000000000..c4268d211e1c --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingAccountWithFilters.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "$filter": "status eq 'active' AND source eq 'consumptioncommitment'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 5000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 60.90 + }, + "source": "ConsumptionCommitment", + "startDate": "2019-10-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "purchasedDate": "2019-09-01T00:00:00Z", + "status": "Active" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingProfile.json new file mode 100644 index 000000000000..88044f10dbd7 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByBillingProfile.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "billingProfileId": "2468" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "creditCurrency": "USD", + "billingCurrency": "USD", + "originalAmount": { + "currency": "USD", + "value": 5000.00 + }, + "originalAmountInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "closedBalance": { + "currency": "USD", + "value": 60.90 + }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information." + }, + "source": "PurchasedCredit", + "startDate": "2024-08-01T00:00:00Z", + "expirationDate": "2024-08-01T00:00:00Z", + "poNumber": "3524", + "isEstimatedBalance": false + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/lots/lot2", + "name": "lot2", + "type": "Microsoft.Consumption/lots", + "properties": { + "creditCurrency": "USD", + "billingCurrency": "USD", + "originalAmount": { + "currency": "USD", + "value": 6000.00 + }, + "originalAmountInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "closedBalance": { + "currency": "USD", + "value": 80.90 + }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller2", + "resellerDescription": "Reseller information." + }, + "source": "PurchasedCredit", + "startDate": "2024-08-01T00:00:00Z", + "expirationDate": "2023-05-31T00:00:00Z", + "poNumber": "31224", + "isEstimatedBalance": false + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomer.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomer.json new file mode 100644 index 000000000000..543d232f90a3 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomer.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "customerId": "1234:5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234/customers/456/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 5000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 60.90 + }, + "source": "PurchasedCredit", + "startDate": "2021-05-01T00:00:00Z", + "expirationDate": "2021-05-01T00:00:00Z", + "poNumber": "3524", + "isEstimatedBalance": false + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234/customers/456/providers/Microsoft.Consumption/lots/lot2", + "name": "lot2", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 6000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 80.90 + }, + "source": "PurchasedCredit", + "startDate": "2021-05-01T00:00:00Z", + "expirationDate": "2019-12-31T00:00:00Z", + "poNumber": "31224", + "isEstimatedBalance": false + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomerWithFilters.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomerWithFilters.json new file mode 100644 index 000000000000..6826c333b5c4 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/LotsListByCustomerWithFilters.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "1234:5678", + "customerId": "1234:5678", + "$filter": "status eq 'active' AND source eq 'consumptioncommitment'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/1234/customers/456/providers/Microsoft.Consumption/lots/lot1", + "name": "lot1", + "type": "Microsoft.Consumption/lots", + "properties": { + "originalAmount": { + "currency": "USD", + "value": 5000.00 + }, + "closedBalance": { + "currency": "USD", + "value": 60.90 + }, + "source": "PurchasedCredit", + "startDate": "2021-05-01T00:00:00Z", + "expirationDate": "2021-05-01T00:00:00Z", + "poNumber": "3524", + "isEstimatedBalance": false + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountList.json new file mode 100644 index 000000000000..a6d1292740a6 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplaceId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan1", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountListForBillingPeriod.json new file mode 100644 index 000000000000..051a219a3e13 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByBillingAccountListForBillingPeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartmentList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartmentList.json new file mode 100644 index 000000000000..70313296d370 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartmentList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "departmentId": "123456", + "billingPeriodName": "201702", + "scope": "providers/Microsoft.Billing/departments/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartment_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartment_ListByBillingPeriod.json new file mode 100644 index 000000000000..70313296d370 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByDepartment_ListByBillingPeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "departmentId": "123456", + "billingPeriodName": "201702", + "scope": "providers/Microsoft.Billing/departments/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccountList.json new file mode 100644 index 000000000000..60a9ceddc4b2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccountList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "enrollmentAccountId": "123456", + "billingPeriodName": "201702", + "scope": "providers/Microsoft.Billing/enrollmentAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json new file mode 100644 index 000000000000..60a9ceddc4b2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "enrollmentAccountId": "123456", + "billingPeriodName": "201702", + "scope": "providers/Microsoft.Billing/enrollmentAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroupList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroupList.json new file mode 100644 index 000000000000..d6e422223359 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroupList.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "managementGroupId": "managementGroupForTest", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-10-13T00:00:00Z", + "usageEnd": "2018-10-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId2", + "name": "marketplacesId2", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account2", + "additionalProperties": "additionalProperties", + "costCenter": "Center2", + "departmentName": "Department2", + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-10-13T00:00:00Z", + "usageEnd": "2018-10-13T23:59:59Z", + "instanceName": "shared2", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "11111111-1111-1111-1111-111111111111", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "11111111-1111-1111-1111-111111111111", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json new file mode 100644 index 000000000000..d45d302910b9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201808", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId2", + "name": "marketplacesId2", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account2", + "additionalProperties": "additionalProperties", + "costCenter": "Center2", + "departmentName": "Department2", + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-13T23:59:59Z", + "instanceName": "shared2", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "11111111-1111-1111-1111-111111111111", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "11111111-1111-1111-1111-111111111111", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesList.json new file mode 100644 index 000000000000..0bcd81bd047b --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketPlaces/marketplaceId1", + "name": "marketplaceId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan1", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesListForBillingPeriod.json new file mode 100644 index 000000000000..3b76c09c629c --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/MarketplacesListForBillingPeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketPlaces/marketplacesId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/OperationList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/OperationList.json new file mode 100644 index 000000000000..a9d4fe3d9c51 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/OperationList.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Microsoft.Consumption/usageDetails/read", + "name": "Microsoft.Consumption/usageDetails/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "UsageDetails", + "operation": "List Usage Details", + "description": "List the usage details for a scope for EA and WebDirect subscriptions." + } + }, + { + "id": "Microsoft.Consumption/reservationSummaries/read", + "name": "Microsoft.Consumption/reservationSummaries/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "ReservationSummaries", + "operation": "List Reservation Utilization Summaries", + "description": "List the utilization summary for reserved instances by reservation order or managment groups. The summary data is either at monthly or daily level." + } + }, + { + "id": "Microsoft.Consumption/reservationDetails/read", + "name": "Microsoft.Consumption/reservationDetails/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "ReservationDetails", + "operation": "List Reservation Utilization Details", + "description": "List the utilization details for reserved instances by reservation order or managment groups. The details data is per instance per day level." + } + }, + { + "id": "Microsoft.Consumption/reservationTransactions/read", + "name": "Microsoft.Consumption/reservationTransactions/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "ReservationTransactions", + "operation": "List Reservation Transactions history", + "description": "List the transaction history for reserved instances by management groups." + } + }, + { + "id": "Microsoft.Consumption/balances/read", + "name": "Microsoft.Consumption/balances/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Balances", + "operation": "List utlization summary", + "description": "List the utilization summary for a billing period for a management group." + } + }, + { + "id": "Microsoft.Consumption/pricesheets/read", + "name": "Microsoft.Consumption/pricesheets/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Pricesheets", + "operation": "List Price sheets", + "description": "List the Pricesheets data for a subscription or a management group." + } + }, + { + "id": "Microsoft.Consumption/marketplaces/read", + "name": "Microsoft.Consumption/marketplaces/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Marketplaces", + "operation": "List Marketplace resource usage", + "description": "List the marketplace resource usage details for a scope for EA and WebDirect subscriptions." + } + }, + { + "id": "Microsoft.Consumption/budgets/read", + "name": "Microsoft.Consumption/budgets/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Budgets", + "operation": "List budgets", + "description": "List the budgets by a subscription or a management group." + } + }, + { + "id": "Microsoft.Consumption/budgets/write", + "name": "Microsoft.Consumption/budgets/write", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Budgets", + "operation": "Create and update budgets", + "description": "Creates and update the budgets by a subscription or a management group." + } + }, + { + "id": "Microsoft.Consumption/budgets/delete", + "name": "Microsoft.Consumption/budgets/delete", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Budgets", + "operation": "Delete budgets", + "description": "Delete the budgets by a subscription or a management group." + } + }, + { + "id": "Microsoft.Consumption/charges/read", + "name": "Microsoft.Consumption/charges/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Charges", + "operation": "List charges", + "description": "List charges" + } + }, + { + "id": "Microsoft.Consumption/credits/read", + "name": "Microsoft.Consumption/credits/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Credits", + "operation": "List credits", + "description": "List credits" + } + }, + { + "id": "Microsoft.Consumption/events/read", + "name": "Microsoft.Consumption/events/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Events", + "operation": "List events", + "description": "List events" + } + }, + { + "id": "Microsoft.Consumption/forecasts/read", + "name": "Microsoft.Consumption/forecasts/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Forecasts", + "operation": "List forecasts", + "description": "List forecasts" + } + }, + { + "id": "Microsoft.Consumption/lots/read", + "name": "Microsoft.Consumption/lots/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Lots", + "operation": "List lots", + "description": "List lots" + } + }, + { + "id": "Microsoft.Consumption/operationstatus/read", + "name": "Microsoft.Consumption/operationstatus/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Operationstatus", + "operation": "List operationstatus", + "description": "List operationstatus" + } + }, + { + "id": "Microsoft.Consumption/operationresults/read", + "name": "Microsoft.Consumption/operationresults/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Operationresults", + "operation": "List operationresults", + "description": "List operationresults" + } + }, + { + "id": "Microsoft.Consumption/register/action", + "name": "Microsoft.Consumption/register/action", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Register", + "operation": "Register to Consumption RP", + "description": "Register to Consumption RP" + } + }, + { + "id": "Microsoft.Consumption/tags/read", + "name": "Microsoft.Consumption/tags/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Tags", + "operation": "List tags", + "description": "List tags for EA and subscriptions." + } + }, + { + "id": "Microsoft.Consumption/tenants/register/action", + "name": "Microsoft.Consumption/tenants/register/action", + "display": { + "provider": "Microsoft.Consumption", + "resource": "tenants/register", + "operation": "register tenants", + "description": "Register action for scope of Microsoft.Consumption by a tenant." + } + }, + { + "id": "Microsoft.Consumption/terms/read", + "name": "Microsoft.Consumption/terms/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Terms", + "operation": "List Terms", + "description": "List the terms for a subscription or a management group." + } + }, + { + "id": "Microsoft.Consumption/reservationRecommendations/read", + "name": "Microsoft.Consumption/reservationRecommendations/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "ReservationRecommendations", + "operation": "List reserved instances recommendations", + "description": "List single or shared recommendations for Reserved instances for a subscription." + } + }, + { + "id": "Microsoft.Consumption/operations/read", + "name": "Microsoft.Consumption/operations/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Operations", + "operation": "List supported operations", + "description": "List all supported operations by Microsoft.Consumption resource provider." + } + }, + { + "id": "Microsoft.Consumption/tenants/read", + "name": "Microsoft.Consumption/tenants/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "Tenants", + "operation": "List tenants", + "description": "List tenants" + } + }, + { + "id": "Microsoft.Consumption/externalBillingAccounts/tags/read", + "name": "Microsoft.Consumption/externalBillingAccounts/tags/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "externalBillingAccounts/Tags", + "operation": "List tags", + "description": "List tags for EA and subscriptions." + } + }, + { + "id": "Microsoft.Consumption/externalSubscriptions/tags/read", + "name": "Microsoft.Consumption/externalSubscriptions/tags/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "externalSubscriptions/Tags", + "operation": "List tags", + "description": "List tags for EA and subscriptions." + } + }, + { + "id": "Microsoft.Consumption/aggregatedcost/read", + "name": "Microsoft.Consumption/aggregatedcost/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "AggregatedCost", + "operation": "List AggregatedCost", + "description": "List AggregatedCost for management group." + } + }, + { + "id": "Microsoft.Consumption/reservationRecommendationDetails/read", + "name": "Microsoft.Consumption/reservationRecommendationDetails/read", + "display": { + "provider": "Microsoft.Consumption", + "resource": "ReservationRecommendationDetails", + "operation": "List Reservation Recommendation Details", + "description": "List Reservation Recommendation Details" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheet.json new file mode 100644 index 000000000000..0068998301f1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId": "OfferId 1", + "savingsPlan": { + "term": "P3Y", + "effectivePrice": 0.002, + "marketPrice": 0.00328 + } + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetExpand.json new file mode 100644 index 000000000000..74bc7a386326 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetExpand.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801", + "$expand": "meterDetails" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D&$expand=properties/pricesheets/meterDetails", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId": "OfferId 1", + "meterDetails": { + "meterName": "Data Transfer Out (GB)", + "meterCategory": "Networking", + "unit": "GB", + "meterLocation": "Zone 2", + "totalIncludedQuantity": 0, + "pretaxStandardRate": 0.138 + } + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetForBillingPeriod.json new file mode 100644 index 000000000000..d7be90ca7902 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/PriceSheetForBillingPeriod.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId": "OfferId 1" + } + ] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetails.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetails.json new file mode 100644 index 000000000000..20d08113d680 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationDetails/20171129", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171129", + "type": "Microsoft.Consumption/reservationDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "usageDate": "2017-11-29T00:00:00Z", + "skuName": "Standard_D2_v2", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/wvn-sql/providers/microsoft.compute/virtualmachines/abc-sql2014sp33", + "totalReservedQuantity": 1.000000000000000, + "reservedHours": 24.000000000000000, + "usedHours": 24.000000000000000, + "instanceFlexibilityGroup": "DSv2 Series", + "instanceFlexibilityRatio": "0.25" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingAccountId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingAccountId.json new file mode 100644 index 000000000000..1ef09a6800ba --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingAccountId.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345", + "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1", + "name": "reservationDetails_Id1", + "type": "Microsoft.Consumption/reservationDetails", + "tags": null, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "usageDate": "2017-11-30T00:00:00-08:00", + "skuName": "Standard_D2s_v3", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1", + "totalReservedQuantity": 0, + "reservedHours": 48, + "usedHours": 0.6, + "instanceFlexibilityGroup": "DSv3 Series", + "instanceFlexibilityRatio": "1" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileId.json new file mode 100644 index 000000000000..c71d1b917b70 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", + "startDate": "2019-09-01", + "endDate": "2019-10-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1", + "name": "reservationDetails_Id1", + "type": "Microsoft.Consumption/reservationDetails", + "tags": null, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "usageDate": "2019-09-30T00:00:00-08:00", + "skuName": "Standard_D2s_v3", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1", + "totalReservedQuantity": 0, + "reservedHours": 48, + "usedHours": 0.6, + "instanceFlexibilityGroup": "DSv3 Series", + "instanceFlexibilityRatio": "1" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileIdReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileIdReservationId.json new file mode 100644 index 000000000000..0b78bbbde8d8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsByBillingProfileIdReservationId.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", + "startDate": "2019-09-01", + "endDate": "2019-10-31", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1", + "name": "reservationDetails_Id1", + "type": "Microsoft.Consumption/reservationDetails", + "tags": null, + "properties": { + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "usageDate": "2019-09-30T00:00:00-08:00", + "skuName": "Standard_D2s_v3", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1", + "totalReservedQuantity": 0, + "reservedHours": 48, + "usedHours": 0.6, + "instanceFlexibilityGroup": "DSv3 Series", + "instanceFlexibilityRatio": "1" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsWithReservationId.json new file mode 100644 index 000000000000..d5d56620329e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationDetailsWithReservationId.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationDetails/20171129", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171129", + "type": "Microsoft.Consumption/reservationDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "usageDate": "2017-11-29T00:00:00Z", + "skuName": "Standard_D2_v2", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/wvn-sql/providers/microsoft.compute/virtualmachines/wvn-sql2014sp33", + "totalReservedQuantity": 1.000000000000000, + "reservedHours": 24.000000000000000, + "usedHours": 24.000000000000000, + "kind": "Reservation", + "instanceFlexibilityGroup": "D2v2 Series", + "instanceFlexibilityRatio": "1" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingAccount.json new file mode 100644 index 000000000000..68052459746c --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingAccount.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/00000000", + "lookBackPeriod": "Last60Days", + "product": "Standard_DS14_v2", + "region": "eastus", + "scope": "Shared", + "term": "P1Y", + "$filter": "properties/subscriptionId eq 00000000-0000-0000-0000-00000000" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/00000000/providers/microsoft.consumption/reservationrecommendationdetails", + "name": "reservationRecommendationDetails", + "type": "Microsoft.Consumption/ReservationRecommendationDetails", + "properties": { + "currency": "USD", + "resource": { + "appliedScopes": [ + "00000000-0000-0000-0000-00000000", + "00000000-0000-0000-0000-00000000" + ], + "onDemandRate": 1.482, + "product": "Standard_DS14_v2", + "region": "eastus", + "reservationRate": 0.70570776255707, + "resourceType": "virtualmachines" + }, + "resourceGroup": null, + "savings": { + "calculatedSavings": [ + { + "onDemandCost": 529550.326618951, + "overageCost": 63253.5935111345, + "quantity": 220, + "reservationCost": 223102.452054792, + "totalReservationCost": 286356.045565927, + "savings": 243194.281053024 + }, + { + "onDemandCost": 529550.326618950, + "overageCost": 149335.025050147, + "quantity": 179, + "reservationCost": 181524.267808217, + "totalReservationCost": 330859.292858364, + "savings": 198691.033760586 + }, + { + "onDemandCost": 529550.326618950, + "overageCost": 195942.319606957, + "quantity": 157, + "reservationCost": 159214.022602738, + "totalReservationCost": 355156.342209695, + "savings": 174393.984409255 + }, + { + "onDemandCost": 529550.326618950, + "overageCost": 30975.2311896299, + "quantity": 241, + "reservationCost": 244398.595205477, + "totalReservationCost": 275373.826395107, + "savings": 254176.500223843 + } + ], + "lookBackPeriod": 60, + "recommendedQuantity": 253.0, + "reservationOrderTerm": "P1Y", + "savingsType": "instance", + "unitOfMeasure": "hour" + }, + "scope": "Shared", + "usage": { + "firstConsumptionDate": "2019-11-27T00:00:00", + "lastConsumptionDate": "2020-01-25T21:00:00", + "lookBackUnitType": "virtualMachine quantity", + "usageData": [ + 275.95003899999995, + 275.916705, + 276.0, + 276.0, + 275.916725, + 275.916705, + 275.98335299999997, + 276.0, + 276.0, + 276.0, + 276.0, + 276.0, + 275.98335299999997, + 276.0, + 276.0, + 276.0, + 276.0, + 275.933352 + ], + "usageGrain": "hourly" + } + } + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingProfile.json new file mode 100644 index 000000000000..0d7da7faf37d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByBillingProfile.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000", + "lookBackPeriod": "Last7Days", + "product": "Standard_B2s", + "region": "australiaeast", + "scope": "Shared", + "term": "P1Y", + "$filter": "properties/subscriptionId eq 00000000-0000-0000-0000-00000000" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails", + "name": "reservationRecommendationDetails", + "type": "Microsoft.Consumption/ReservationRecommendationDetails", + "properties": { + "currency": "AUD", + "resource": { + "appliedScopes": [ + "00000000-0000-0000-0000-00000000" + ], + "onDemandRate": 0.0725, + "product": "Standard_B2s", + "region": "australiaeast", + "reservationRate": 0.044141665317880413, + "resourceType": "virtualmachines" + }, + "resourceGroup": null, + "savings": { + "calculatedSavings": [ + { + "onDemandCost": 632.884472049689441, + "overageCost": 0.0, + "quantity": 1, + "reservationCost": 387.740388152261739, + "totalReservationCost": 387.740388152261739, + "savings": 245.144083897427702 + } + ], + "lookBackPeriod": 7, + "recommendedQuantity": 1.0, + "reservationOrderTerm": "P1Y", + "savingsType": "instance", + "unitOfMeasure": "hour" + }, + "scope": "Shared", + "usage": { + "firstConsumptionDate": "2020-01-19T00:00:00", + "lastConsumptionDate": "2020-01-25T17:00:00", + "lookBackUnitType": "virtualMachine quantity", + "usageData": [ + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 0.0 + ], + "usageGrain": "hourly" + } + } + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByResourceGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByResourceGroup.json new file mode 100644 index 000000000000..46bbabd5e673 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup", + "lookBackPeriod": "Last30Days", + "product": "Standard_DS13_v2", + "region": "westus", + "scope": "Single", + "term": "P3Y" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/microsoft.consumption/reservationrecommendationdetails", + "name": "reservationRecommendationDetails", + "type": "Microsoft.Consumption/ReservationRecommendationDetails", + "properties": { + "currency": "USD", + "resource": { + "appliedScopes": [ + "00000000-0000-0000-0000-00000000", + "testGroup" + ], + "onDemandRate": 0.519, + "product": "Standard_DS13_v2", + "region": "westus", + "reservationRate": 0.302549467275493, + "resourceType": "virtualmachines" + }, + "resourceGroup": "testGroup", + "savings": { + "calculatedSavings": [ + { + "onDemandCost": 368.4813602070006, + "overageCost": 0.0, + "quantity": 2, + "reservationCost": 429.01514459665, + "totalReservationCost": 429.01514459665, + "savings": -60.5337843896494 + }, + { + "onDemandCost": 368.481360207000, + "overageCost": 1.557, + "quantity": 1, + "reservationCost": 214.507572298325, + "totalReservationCost": 216.064572298325, + "savings": 152.416787908675 + } + ], + "lookBackPeriod": 30, + "recommendedQuantity": 1.0, + "reservationOrderTerm": "P3Y", + "savingsType": "instance", + "unitOfMeasure": "hour" + }, + "scope": "Single", + "usage": { + "firstConsumptionDate": "2020-02-03T00:00:00", + "lastConsumptionDate": "2020-03-03T13:00:00", + "lookBackUnitType": "virtualMachine quantity", + "usageData": [ + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0 + ], + "usageGrain": "hourly" + } + } + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsBySubscription.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsBySubscription.json new file mode 100644 index 000000000000..2d5e42cda30a --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationDetailsBySubscription.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "subscriptions/00000000-0000-0000-0000-00000000", + "lookBackPeriod": "Last30Days", + "product": "Standard_DS13_v2", + "region": "westus", + "scope": "Single", + "term": "P3Y" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails", + "name": "reservationRecommendationDetails", + "type": "Microsoft.Consumption/ReservationRecommendationDetails", + "properties": { + "currency": "USD", + "resource": { + "appliedScopes": [ + "00000000-0000-0000-0000-00000000" + ], + "onDemandRate": 0.519, + "product": "Standard_DS13_v2", + "region": "westus", + "reservationRate": 0.302549467275493, + "resourceType": "virtualmachines" + }, + "resourceGroup": null, + "savings": { + "calculatedSavings": [ + { + "onDemandCost": 368.4813602070006, + "overageCost": 0.0, + "quantity": 2, + "reservationCost": 429.01514459665, + "totalReservationCost": 429.01514459665, + "savings": -60.5337843896494 + }, + { + "onDemandCost": 368.481360207000, + "overageCost": 1.557, + "quantity": 1, + "reservationCost": 214.507572298325, + "totalReservationCost": 216.064572298325, + "savings": 152.416787908675 + } + ], + "lookBackPeriod": 30, + "recommendedQuantity": 1.0, + "reservationOrderTerm": "P3Y", + "savingsType": "instance", + "unitOfMeasure": "hour" + }, + "scope": "Single", + "usage": { + "firstConsumptionDate": "2020-02-03T00:00:00", + "lastConsumptionDate": "2020-03-03T13:00:00", + "lookBackUnitType": "virtualMachine quantity", + "usageData": [ + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0 + ], + "usageGrain": "hourly" + } + } + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccount.json new file mode 100644 index 000000000000..df9fc4cb3d00 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccount.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/reservationRecommendations", + "location": "westus", + "sku": "Standard_DS1_v2", + "kind": "legacy", + "properties": { + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 12.0785105, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 11.4899644807748, + "netSavings": 0.588546019225182, + "firstUsageDate": "2019-07-07T00:00:00-07:00", + "scope": "Shared", + "lookBackPeriod": "Last7Days", + "instanceFlexibilityRatio": 1, + "instanceFlexibilityGroup": "DSv2 Series", + "normalizedSize": "Standard_DS1_v2", + "recommendedQuantityNormalized": 1, + "skuProperties": [ + { + "name": "Cores", + "value": "1" + }, + { + "name": "Ram", + "value": "1" + } + ], + "totalHours": 701, + "lastUsageDate": "2019-08-07T00:00:00-07:00" + } + }, + { + "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/reservationRecommendations", + "location": "westus", + "sku": "Standard_DS1_v2", + "kind": "legacy", + "properties": { + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 10.0785105, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 13.48, + "netSavings": 0.68, + "firstUsageDate": "2019-07-07T00:00:00-07:00", + "scope": "Shared", + "lookBackPeriod": "Last7Days", + "instanceFlexibilityRatio": 1, + "instanceFlexibilityGroup": "DSv2 Series", + "normalizedSize": "Standard_DS1", + "recommendedQuantityNormalized": 1.2, + "skuProperties": [ + { + "name": "SkuDisplayName", + "value": "B" + }, + { + "name": "CPU", + "value": "1" + } + ], + "totalHours": 805, + "lastUsageDate": "2019-08-09T00:00:00-07:00" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&" + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccountFilterByScope.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccountFilterByScope.json new file mode 100644 index 000000000000..79e0a430d7a5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingAccountFilterByScope.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/123456", + "$filter": "properties/scope eq 'Single'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "legacy", + "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/71fd91a7-13b9-4ade-bb11-85cfd6422d9d", + "name": "71fd91a7-13b9-4ade-bb11-85cfd6422d9d", + "type": "Microsoft.Consumption/reservationRecommendations", + "location": "westus3", + "sku": "Standard_B4ms", + "properties": { + "meterId": "9a3781ce-d0dc-5f76-99d7-29eb5aec447f", + "term": "P1Y", + "costWithNoReservedInstances": 0.332, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.19474885844748857, + "netSavings": 0.13725114155251145, + "firstUsageDate": "2024-04-30T07:00:00Z", + "scope": "Single", + "lookBackPeriod": "Last7Days", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceType": "virtualmachines", + "instanceFlexibilityRatio": 8, + "instanceFlexibilityGroup": "BS Series High Memory", + "normalizedSize": "Standard_B1ms", + "recommendedQuantityNormalized": 8, + "skuProperties": [] + } + }, + { + "kind": "legacy", + "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/904b99c2-baf3-4bff-98ff-a96238ccbc96", + "name": "904b99c2-baf3-4bff-98ff-a96238ccbc96", + "type": "Microsoft.Consumption/reservationRecommendations", + "location": "westus3", + "sku": "Standard_B4ms", + "properties": { + "meterId": "9a3781ce-d0dc-5f76-99d7-29eb5aec447f", + "term": "P3Y", + "costWithNoReservedInstances": 0.332, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.12511415525114156, + "netSavings": 0.20688584474885846, + "firstUsageDate": "2024-04-30T07:00:00Z", + "scope": "Single", + "lookBackPeriod": "Last7Days", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceType": "virtualmachines", + "instanceFlexibilityRatio": 8, + "instanceFlexibilityGroup": "BS Series High Memory", + "normalizedSize": "Standard_B1ms", + "recommendedQuantityNormalized": 8, + "skuProperties": [] + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingProfile.json new file mode 100644 index 000000000000..74f8912b0985 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByBillingProfile.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/123456/billingProfiles/6420" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/billingProfiles/6420/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/reservationRecommendations", + "kind": "modern", + "properties": { + "costWithNoReservedInstances": { + "currency": "USD", + "value": 279881.9457795231 + }, + "firstUsageDate": "2022-08-22T00:00:00Z", + "instanceFlexibilityGroup": "NA", + "instanceFlexibilityRatio": 1, + "location": "westus2", + "lookBackPeriod": 60, + "meterId": "30f7049a-b092-42f4-9173-9ec31ab945ad", + "netSavings": { + "currency": "USD", + "value": 153766.87728637524 + }, + "normalizedSize": "SQLDB_BC_Compute_Gen5", + "recommendedQuantity": 35, + "recommendedQuantityNormalized": 35, + "resourceType": "sqldatabases", + "scope": "Single", + "skuName": "SQLDB_BC_Compute_Gen5", + "skuProperties": null, + "subscriptionId": "c6aa8a01-a744-44a7-a4f1-caad17512f27", + "term": "P3Y", + "totalCostWithReservedInstances": { + "currency": "USD", + "value": 126115.06849314792 + }, + "totalHours": 717, + "lastUsageDate": "2022-09-22T00:00:00Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/billingProfiles/6420/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/reservationRecommendations", + "kind": "modern", + "properties": { + "costWithNoReservedInstances": { + "currency": "USD", + "value": 93208.8596802244 + }, + "firstUsageDate": "2022-08-22T00:00:00Z", + "instanceFlexibilityGroup": "NA", + "instanceFlexibilityRatio": 1, + "location": "westus2", + "lookBackPeriod": 60, + "meterId": "30f7049a-b092-42f4-9173-9ec31ab945ad", + "netSavings": { + "currency": "USD", + "value": 32553.85968022456 + }, + "normalizedSize": "SQLDB_BC_Compute_Gen5", + "recommendedQuantity": 35, + "recommendedQuantityNormalized": 35, + "resourceType": "sqldatabases", + "scope": "Single", + "skuName": "SQLDB_BC_Compute_Gen5", + "skuProperties": null, + "subscriptionId": "c6aa8a01-a744-44a7-a4f1-caad17512f27", + "term": "P1Y", + "totalCostWithReservedInstances": { + "currency": "USD", + "value": 60654.99999999984 + }, + "totalHours": 527, + "lastUsageDate": "2022-08-27T00:00:00Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&" + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByResourceGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByResourceGroup.json new file mode 100644 index 000000000000..8ceee0cf4663 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsByResourceGroup.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGrouups/testGroup/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1", + "name": "reservationRecommendations1", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 4.634521202630137, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "totalHours": 427, + "lastUsageDate": "2018-03-08T00:00:00Z" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2", + "name": "reservationRecommendations2", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P3Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 7.2893157231780812, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "totalHours": 327, + "lastUsageDate": "2018-03-09T00:00:00Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&" + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsBySubscription.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsBySubscription.json new file mode 100644 index 000000000000..9057e74623b9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsBySubscription.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1", + "name": "reservationRecommendations1", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 4.634521202630137, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "totalHours": 827, + "lastUsageDate": "2018-03-10T00:00:00Z" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2", + "name": "reservationRecommendations2", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P3Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 7.2893157231780812, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "totalHours": 927, + "lastUsageDate": "2018-03-15T00:00:00Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&" + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod.json new file mode 100644 index 000000000000..bf376098eb94 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "subscriptions/00000000-0000-0000-0000-000000000000", + "$filter": "properties/scope eq 'Single' AND properties/lookBackPeriod eq 'Last7Days'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1", + "name": "reservationRecommendations1", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 4.634521202630137, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single", + "skuProperties": [ + { + "name": "Cores", + "value": "1" + }, + { + "name": "Ram", + "value": "1" + } + ], + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "totalHours": 527, + "lastUsageDate": "2018-03-15T00:00:00Z" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2", + "name": "reservationRecommendations2", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P3Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 7.2893157231780812, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single", + "skuProperties": [ + { + "name": "SkuDisplayName", + "value": "B" + }, + { + "name": "CPU", + "value": "1" + } + ], + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "totalHours": 427, + "lastUsageDate": "2018-03-08T00:00:00Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$filter=properties/scope+eq+'Single'+AND+properties/lookBackPeriod+eq+'Last7Days'&$skiptoken=AQAAAA%3D%3D&" + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDaily.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDaily.json new file mode 100644 index 000000000000..4f42db9012c3 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDaily.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "grain": "daily", + "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "kind": "Reservation", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0, + "purchasedQuantity": 0, + "remainingQuantity": 0, + "totalReservedQuantity": 155, + "usedQuantity": 0, + "utilizedPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingAccountId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingAccountId.json new file mode 100644 index 000000000000..25f4133b7985 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingAccountId.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345", + "grain": "daily", + "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1", + "name": "reservationSummaries_Id1", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": null, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_B1s", + "reservedHours": 720, + "usageDate": "2018-09-01T00:00:00-07:00", + "usedHours": 0, + "minUtilizationPercentage": 0, + "avgUtilizationPercentage": 0, + "maxUtilizationPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingProfileId.json new file mode 100644 index 000000000000..5404b2272eac --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithBillingProfileId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", + "grain": "daily", + "startDate": "2017-10-01", + "endDate": "2017-11-20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1", + "name": "reservationSummaries_Id1", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": null, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_B1s", + "reservedHours": 720, + "usageDate": "2018-09-01T00:00:00-07:00", + "usedHours": 0, + "minUtilizationPercentage": 0, + "avgUtilizationPercentage": 0, + "maxUtilizationPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithReservationId.json new file mode 100644 index 000000000000..cc621f13b962 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesDailyWithReservationId.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "grain": "daily", + "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "kind": "Reservation", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0, + "purchasedQuantity": 0, + "remainingQuantity": 0, + "totalReservedQuantity": 155, + "usedQuantity": 0, + "utilizedPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthly.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthly.json new file mode 100644 index 000000000000..2dbf5934aa7e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthly.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "grain": "monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "kind": "Reservation", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0, + "purchasedQuantity": 0, + "remainingQuantity": 0, + "totalReservedQuantity": 155, + "usedQuantity": 0, + "utilizedPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json new file mode 100644 index 000000000000..0fd8b833bdb5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345", + "grain": "monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1", + "name": "reservationSummaries_Id1", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": null, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_B1s", + "reservedHours": 720, + "usageDate": "2018-09-01T00:00:00-07:00", + "usedHours": 0, + "minUtilizationPercentage": 0, + "avgUtilizationPercentage": 0, + "maxUtilizationPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json new file mode 100644 index 000000000000..8d7fb87728af --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", + "grain": "monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1", + "name": "reservationSummaries_Id1", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": null, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_B1s", + "reservedHours": 720, + "usageDate": "2018-09-01T00:00:00-07:00", + "usedHours": 0, + "minUtilizationPercentage": 0, + "avgUtilizationPercentage": 0, + "maxUtilizationPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json new file mode 100644 index 000000000000..aee233ec753a --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "resourceScope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", + "grain": "monthly", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1", + "name": "reservationSummaries_Id1", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": null, + "properties": { + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "skuName": "Standard_B1s", + "reservedHours": 720, + "usageDate": "2018-09-01T00:00:00-07:00", + "usedHours": 0, + "minUtilizationPercentage": 0, + "avgUtilizationPercentage": 0, + "maxUtilizationPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithReservationId.json new file mode 100644 index 000000000000..87ee687b3cf5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationSummariesMonthlyWithReservationId.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "grain": "monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "kind": "Reservation", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0, + "purchasedQuantity": 0, + "remainingQuantity": 0, + "totalReservedQuantity": 155, + "usedQuantity": 0, + "utilizedPercentage": 0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByBillingProfileId.json new file mode 100644 index 000000000000..14487b39046e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByBillingProfileId.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "$filter": "properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30", + "billingAccountId": "fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30", + "billingProfileId": "Z76D-SGAF-BG7-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/billingProfiles/Z76D-SGAF-BG7-TGB/providers/Microsoft.Consumption/reservationTransactions", + "name": "a838a8c3-a408-49e1-ac90-42cb95bff9b2", + "type": "Microsoft.Consumption/reservationTransactions", + "properties": { + "eventDate": "2020-04-25T21:21:38Z", + "reservationOrderId": "a838a8c3-a408-49e1-ac90-42cb95bff9b2", + "description": "Reserved VM Instance, Standard_B1ls, US East, 3 Years", + "eventType": "Purchase", + "quantity": 1, + "amount": 1.44, + "currency": "USD", + "reservationOrderName": "VM_RI_03-25-2020_14-18", + "armSkuName": "Standard_B1ls", + "billingFrequency": "Recurring", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/billingProfiles/Z76D-SGAF-BG7-TGB", + "billingProfileName": "IT Department*", + "invoice": "T000456437", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/billingProfiles/Z76D-SGAF-BG7-TGB/invoices/T000456437", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/invoiceSections/QBTB-EYAK-PJA-TGB", + "invoiceSectionName": "IT Department", + "purchasingSubscriptionGuid": "d924ad15-4a3d-4047-971d-c8b1b300a97b", + "purchasingSubscriptionName": "contoso", + "region": "eastus", + "term": "P3Y" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByEnrollmentNumber.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByEnrollmentNumber.json new file mode 100644 index 000000000000..a798f59266f1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/ReservationTransactionsListByEnrollmentNumber.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "$filter": "properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30", + "useMarkupIfPartner": true, + "previewMarkupPercentage": 15.5, + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919", + "name": "201909091919", + "type": "Microsoft.Consumption/reservationTransactions", + "tags": [], + "properties": { + "eventDate": "2019-09-09T19:19:04Z", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "description": "Standard_DS1_v2 westus 1 Year", + "eventType": "Refund", + "quantity": 1, + "amount": -21.000000000000000, + "currency": "USD", + "reservationOrderName": "Transaction-DS1_v2", + "purchasingEnrollment": "123456", + "armSkuName": "Standard_DS1_v2", + "term": "P1Y", + "region": "westus", + "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2", + "purchasingSubscriptionName": "Infrastructure Subscription", + "accountName": "Microsoft Infrastructure", + "accountOwnerEmail": "admin@microsoft.com", + "departmentName": "Unassigned", + "costCenter": "", + "currentEnrollment": "123456", + "billingFrequency": "recurring", + "billingMonth": 20190901, + "monetaryCommitment": 523123.90, + "overage": 23234.49 + } + }, + { + "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919", + "name": "201909091919", + "type": "Microsoft.Consumption/reservationTransactions", + "tags": [], + "properties": { + "eventDate": "2019-09-09T19:19:04Z", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "description": "Standard_DS1_v2 westus 1 Year", + "eventType": "Purchase", + "quantity": 1, + "amount": 21.000000000000000, + "currency": "USD", + "reservationOrderName": "Transaction-DS1_v2", + "purchasingEnrollment": "123456", + "armSkuName": "Standard_DS1_v2", + "term": "P1Y", + "region": "westus", + "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2", + "purchasingSubscriptionName": "Infrastructure Subscription", + "accountName": "Microsoft Infrastructure", + "accountOwnerEmail": "admin@microsoft.com", + "departmentName": "Unassigned", + "costCenter": "", + "currentEnrollment": "123456", + "billingFrequency": "recurring", + "billingMonth": 20190901, + "monetaryCommitment": 523123.90, + "overage": 23234.49 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Tags.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Tags.json new file mode 100644 index 000000000000..8ffcac6f7d58 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/Tags.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "billingAccountId": "12345", + "scope": "providers/Microsoft.CostManagement/billingAccounts/1234" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/tags/tags1", + "name": "tags1", + "type": "Microsoft.Consumption/tags", + "eTag": "\"1d34d012214157f\"", + "properties": { + "tags": [ + { + "key": "Department" + }, + { + "key": "CostCenter" + }, + { + "key": "Portal" + }, + { + "key": "OrgName" + }, + { + "key": "Namespace" + }, + { + "key": "resourceType" + }, + { + "key": "Subsystem" + }, + { + "key": "Environment" + }, + { + "key": "clusterName" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/tags/?$expand=properties/tags/value&api-version=2024-08-01&startDate=2020-12-01&endDate=2020-12-31&$top=1000&$skiptoken=AwAAAA%3D%3D", + "previousLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/tags/?$expand=properties/tags/value&api-version=2024-08-01&startDate=2020-12-01&endDate=2020-12-31&$top=1000&$skiptoken=AQAAAA%3D%3D" + } + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsExpand.json new file mode 100644 index 000000000000..52061bfe3fb9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsExpand.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201903", + "$expand": "meterDetails,additionalInfo", + "$filter": "tags eq 'dev:tools'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": { + "meterName": "Data Transfer Out (GB)", + "meterCategory": "Networking", + "meterSubCategory": "ExpressRoute", + "unitOfMeasure": "GB", + "serviceFamily": "Compute" + }, + "quantity": 0.8234, + "effectivePrice": 0.010464556322455, + "cost": 0.000342194841184, + "unitPrice": 3.54, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "frequency": "UsageBased", + "additionalInfo": "{\"MyType\":\"\",\"ServiceType\":\"\",\"VMName\":\"\",\"UsageType\":\"MyUsage\"}", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsList.json new file mode 100644 index 000000000000..e4faebb90a90 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Customer Name 1", + "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Customer Name 1", + "accountName": "AccountName", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "SubscriptionName 1", + "date": "2019-04-09T00:00:00.0000000Z", + "product": "Product1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.000036, + "effectivePrice": 0.054693034210767, + "cost": 0.000001980949998, + "unitPrice": 5.47, + "billingCurrency": "CAD", + "resourceLocation": "uswest", + "consumedService": "Microsoft.ClassicStorage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1", + "resourceName": "ResourceName1", + "invoiceSection": "Invoice Section 1", + "costCenter": "BAS", + "resourceGroup": "Resource-Group-westus", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "frequency": "UsageBased", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByBillingAccount.json new file mode 100644 index 000000000000..2fcc2f04ed60 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByBillingAccount.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.7329, + "effectivePrice": 0.000402776395232, + "cost": 0.000295194820065, + "unitPrice": 4.38, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByDepartment.json new file mode 100644 index 000000000000..51a88ad9002d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByDepartment.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/Departments/1234", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.7329, + "effectivePrice": 0.000402776395232, + "cost": 0.000295194820065, + "unitPrice": 4.38, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByEnrollmentAccount.json new file mode 100644 index 000000000000..746825f5e789 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByEnrollmentAccount.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/EnrollmentAccounts/1234", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.7329, + "effectivePrice": 0.000402776395232, + "cost": 0.000295194820065, + "unitPrice": 4.38, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingAccount.json new file mode 100644 index 000000000000..96d25f52ec5b --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingAccount.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234:56789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "modern", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "1234:56789", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-09-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-10-31T00:00:00.0000000Z", + "billingProfileId": "2468", + "billingProfileName": "Account Name 1", + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-10-30T00:00:00.0000000Z", + "meterId": "00000000-0000-0000-0000-000000000000", + "quantity": 0.7329, + "unitPrice": 4.38, + "billingCurrencyCode": "USD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "instanceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "invoiceSectionId": "98765", + "invoiceSectionName": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "additionalInfo": "{ \"UsageType\": \"ComputeHR\", \"ImageType\": \"Windows Client BYOL\", \"ServiceType\": \"Standard_D1\", \"VMName\": null, \"VMProperties\": null, \"VCPUs\": 1, \"CPUs\": 0}", + "costInBillingCurrency": 1.84763819095477, + "costInPricingCurrency": 1.84763819095477, + "exchangeRate": "1", + "exchangeRateDate": "2019-09-30T00:00:00Z", + "invoiceId": "", + "previousInvoiceId": "", + "pricingCurrencyCode": "USD", + "product": "Virtual Machines D Series - D1 - US East", + "productIdentifier": "DZH318Z0BQ4B00FV", + "productOrderId": "a3db7880-70eb-4b4c-6a79-1425a058df5a", + "productOrderName": "Azure plan", + "publisherName": "Microsoft", + "publisherType": "Microsoft", + "resourceLocationNormalized": "US East", + "serviceInfo1": "", + "serviceInfo2": "Windows Client BYOL", + "servicePeriodEndDate": "2019-12-01T00:00:00Z", + "servicePeriodStartDate": "2019-09-01T00:00:00Z", + "customerTenantId": "00000000-0000-0000-0000-000000000000", + "customerName": "Modern Azure Customer 1", + "partnerTenantId": "00000000-0000-0000-0000-000000000000", + "partnerName": "Partner Name 1", + "resellerMpnId": "", + "resellerName": "Reseller Name 1", + "publisherId": "", + "reservationId": "", + "reservationName": "", + "frequency": "UsageBased", + "term": "", + "marketPrice": 0.077, + "costInUSD": 1.84763819095477, + "paygCostInBillingCurrency": 1.848, + "paygCostInUSD": 1.848, + "exchangeRatePricingToBilling": 0.077, + "partnerEarnedCreditRate": 0.077, + "partnerEarnedCreditApplied": "0", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingProfile.json new file mode 100644 index 000000000000..9fbdcc989531 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCABillingProfile.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234:56789/billingProfiles/2468" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789/billingProfiles/2468/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "modern", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "1234:56789", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-09-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-10-31T00:00:00.0000000Z", + "billingProfileId": "2468", + "billingProfileName": "Account Name 1", + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-10-30T00:00:00.0000000Z", + "meterId": "00000000-0000-0000-0000-000000000000", + "quantity": 0.7329, + "unitPrice": 4.38, + "billingCurrencyCode": "USD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "instanceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "invoiceSectionId": "98765", + "invoiceSectionName": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "additionalInfo": "{ \"UsageType\": \"ComputeHR\", \"ImageType\": \"Windows Client BYOL\", \"ServiceType\": \"Standard_D1\", \"VMName\": null, \"VMProperties\": null, \"VCPUs\": 1, \"CPUs\": 0}", + "costInBillingCurrency": 1.84763819095477, + "costInPricingCurrency": 1.84763819095477, + "exchangeRate": "1", + "exchangeRateDate": "2019-09-30T00:00:00Z", + "invoiceId": "", + "previousInvoiceId": "", + "pricingCurrencyCode": "USD", + "product": "Virtual Machines D Series - D1 - US East", + "productIdentifier": "DZH318Z0BQ4B00FV", + "productOrderId": "a3db7880-70eb-4b4c-6a79-1425a058df5a", + "productOrderName": "Azure plan", + "publisherName": "Microsoft", + "publisherType": "Microsoft", + "resourceLocationNormalized": "US East", + "serviceInfo1": "", + "serviceInfo2": "Windows Client BYOL", + "servicePeriodEndDate": "2019-12-01T00:00:00Z", + "servicePeriodStartDate": "2019-09-01T00:00:00Z", + "customerTenantId": "00000000-0000-0000-0000-000000000000", + "customerName": "Modern Azure Customer 1", + "partnerTenantId": "00000000-0000-0000-0000-000000000000", + "partnerName": "Partner Name 1", + "resellerMpnId": "", + "resellerName": "Reseller Name 1", + "publisherId": "", + "reservationId": "", + "reservationName": "", + "frequency": "UsageBased", + "term": "", + "marketPrice": 0.077, + "costInUSD": 1.84763819095477, + "paygCostInBillingCurrency": 1.848, + "paygCostInUSD": 1.848, + "exchangeRatePricingToBilling": 0.077, + "partnerEarnedCreditRate": 0.077, + "partnerEarnedCreditApplied": "0", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCACustomer.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCACustomer.json new file mode 100644 index 000000000000..2c93e5e60a1d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCACustomer.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234:56789/customers/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789/customers/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "modern", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "1234:56789", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-09-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-10-31T00:00:00.0000000Z", + "billingProfileId": "2468", + "billingProfileName": "Account Name 1", + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-10-30T00:00:00.0000000Z", + "meterId": "00000000-0000-0000-0000-000000000000", + "quantity": 0.7329, + "unitPrice": 4.38, + "billingCurrencyCode": "USD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "instanceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "invoiceSectionId": "98765", + "invoiceSectionName": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "additionalInfo": "{ \"UsageType\": \"ComputeHR\", \"ImageType\": \"Windows Client BYOL\", \"ServiceType\": \"Standard_D1\", \"VMName\": null, \"VMProperties\": null, \"VCPUs\": 1, \"CPUs\": 0}", + "costInBillingCurrency": 1.84763819095477, + "costInPricingCurrency": 1.84763819095477, + "exchangeRate": "1", + "exchangeRateDate": "2019-09-30T00:00:00Z", + "invoiceId": "", + "previousInvoiceId": "", + "pricingCurrencyCode": "USD", + "product": "Virtual Machines D Series - D1 - US East", + "productIdentifier": "DZH318Z0BQ4B00FV", + "productOrderId": "a3db7880-70eb-4b4c-6a79-1425a058df5a", + "productOrderName": "Azure plan", + "publisherName": "Microsoft", + "publisherType": "Microsoft", + "resourceLocationNormalized": "US East", + "serviceInfo1": "", + "serviceInfo2": "Windows Client BYOL", + "servicePeriodEndDate": "2019-12-01T00:00:00Z", + "servicePeriodStartDate": "2019-09-01T00:00:00Z", + "customerTenantId": "00000000-0000-0000-0000-000000000000", + "customerName": "Modern Azure Customer 1", + "partnerTenantId": "00000000-0000-0000-0000-000000000000", + "partnerName": "Partner Name 1", + "resellerMpnId": "", + "resellerName": "Reseller Name 1", + "publisherId": "", + "reservationId": "", + "reservationName": "", + "frequency": "UsageBased", + "term": "", + "marketPrice": 0.077, + "costInUSD": 1.84763819095477, + "paygCostInBillingCurrency": 1.848, + "paygCostInUSD": 1.848, + "exchangeRatePricingToBilling": 0.077, + "partnerEarnedCreditRate": 0.077, + "partnerEarnedCreditApplied": "0", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCAInvoiceSection.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCAInvoiceSection.json new file mode 100644 index 000000000000..b3300067ba99 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMCAInvoiceSection.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234:56789/invoiceSections/98765" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234:56789/invoiceSections/98765/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "modern", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "1234:56789", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-09-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-10-31T00:00:00.0000000Z", + "billingProfileId": "2468", + "billingProfileName": "Account Name 1", + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-10-30T00:00:00.0000000Z", + "meterId": "00000000-0000-0000-0000-000000000000", + "quantity": 0.7329, + "unitPrice": 4.38, + "billingCurrencyCode": "USD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "instanceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "invoiceSectionId": "98765", + "invoiceSectionName": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "additionalInfo": "{ \"UsageType\": \"ComputeHR\", \"ImageType\": \"Windows Client BYOL\", \"ServiceType\": \"Standard_D1\", \"VMName\": null, \"VMProperties\": null, \"VCPUs\": 1, \"CPUs\": 0}", + "costInBillingCurrency": 1.84763819095477, + "costInPricingCurrency": 1.84763819095477, + "exchangeRate": "1", + "exchangeRateDate": "2019-09-30T00:00:00Z", + "invoiceId": "", + "previousInvoiceId": "", + "pricingCurrencyCode": "USD", + "product": "Virtual Machines D Series - D1 - US East", + "productIdentifier": "DZH318Z0BQ4B00FV", + "productOrderId": "a3db7880-70eb-4b4c-6a79-1425a058df5a", + "productOrderName": "Azure plan", + "publisherName": "Microsoft", + "publisherType": "Microsoft", + "resourceLocationNormalized": "US East", + "serviceInfo1": "", + "serviceInfo2": "Windows Client BYOL", + "servicePeriodEndDate": "2019-12-01T00:00:00Z", + "servicePeriodStartDate": "2019-09-01T00:00:00Z", + "customerTenantId": "00000000-0000-0000-0000-000000000000", + "customerName": "Modern Azure Customer 1", + "partnerTenantId": "00000000-0000-0000-0000-000000000000", + "partnerName": "Partner Name 1", + "resellerMpnId": "", + "resellerName": "Reseller Name 1", + "publisherId": "", + "reservationId": "", + "reservationName": "", + "frequency": "UsageBased", + "term": "", + "marketPrice": 0.077, + "costInUSD": 1.84763819095477, + "paygCostInBillingCurrency": 1.848, + "paygCostInUSD": 1.848, + "exchangeRatePricingToBilling": 0.077, + "partnerEarnedCreditRate": 0.077, + "partnerEarnedCreditApplied": "0", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByManagementGroup.json new file mode 100644 index 000000000000..82994618651d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByManagementGroup.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201903", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.8234, + "effectivePrice": 0.010534556373432, + "cost": 0.000342194841184, + "unitPrice": 3.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + }, + { + "id": "/scope/providers/Microsoft.Billing/billingPeriods/20180801/providers/Microsoft.Consumption/usageDetails/usageDetails_Id2", + "name": "usageDetails_Id2", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 2", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 2", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 2", + "partNumber": "Part Number 2", + "meterId": "11111111-1111-1111-1111-111111111111", + "meterDetails": null, + "quantity": 0.7329, + "effectivePrice": 0.000402776395232, + "cost": 0.000295194820065, + "unitPrice": 4.38, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 2/providers/Microsoft.Storage/storageAccounts/Resource Name 2", + "resourceName": "Resource Name 2", + "invoiceSection": "Invoice Section 2", + "costCenter": "DEV", + "resourceGroup": "Resource Group 2", + "offerId": "Offer Id 2", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricActualCost.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricActualCost.json new file mode 100644 index 000000000000..bfd3c5f642de --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricActualCost.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "metric": "actualcost", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Customer Name 1", + "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Customer Name 1", + "accountName": "AccountName", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "SubscriptionName 1", + "date": "2019-04-09T00:00:00.0000000Z", + "product": "Product1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.000036, + "effectivePrice": 0.054693055510767, + "cost": 0.000001968949998, + "unitPrice": 5.47, + "billingCurrency": "CAD", + "resourceLocation": "uswest", + "consumedService": "Microsoft.ClassicStorage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1", + "resourceName": "ResourceName1", + "invoiceSection": "Invoice Section 1", + "costCenter": "BAS", + "resourceGroup": "Resource-Group-westus", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricAmortizedCost.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricAmortizedCost.json new file mode 100644 index 000000000000..d9f7f79d8ea5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricAmortizedCost.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "metric": "amortizedcost", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Customer Name 1", + "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Customer Name 1", + "accountName": "AccountName", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "SubscriptionName 1", + "date": "2019-04-09T00:00:00.0000000Z", + "product": "Product1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.000036, + "effectivePrice": 0.054693055510767, + "cost": 0.000001968949998, + "unitPrice": 5.47, + "billingCurrency": "CAD", + "resourceLocation": "uswest", + "consumedService": "Microsoft.ClassicStorage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1", + "resourceName": "ResourceName1", + "invoiceSection": "Invoice Section 1", + "costCenter": "BAS", + "resourceGroup": "Resource-Group-westus", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "frequency": "UsageBased", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricUsage.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricUsage.json new file mode 100644 index 000000000000..65db7c3eca00 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListByMetricUsage.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "metric": "usage", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Customer Name 1", + "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Customer Name 1", + "accountName": "AccountName", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "SubscriptionName 1", + "date": "2019-04-09T00:00:00.0000000Z", + "product": "Product1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.000036, + "effectivePrice": 0.054693055510767, + "cost": 0.000001968949998, + "unitPrice": 5.47, + "billingCurrency": "CAD", + "resourceLocation": "uswest", + "consumedService": "Microsoft.ClassicStorage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1", + "resourceName": "ResourceName1", + "invoiceSection": "Invoice Section 1", + "costCenter": "BAS", + "resourceGroup": "Resource-Group-westus", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListFilterByTag.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListFilterByTag.json new file mode 100644 index 000000000000..691a0c054a28 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListFilterByTag.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "$filter": "tags eq 'dev:tools'", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.8234, + "effectivePrice": 0.010534556373432, + "cost": 0.000342194841184, + "unitPrice": 3.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriod.json new file mode 100644 index 000000000000..7b19b037b928 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriod.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.8234, + "effectivePrice": 0.010534556373432, + "cost": 0.000342194841184, + "unitPrice": 3.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByBillingAccount.json new file mode 100644 index 000000000000..e67b76843048 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByBillingAccount.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/BillingAccounts/1234", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.8234, + "effectivePrice": 0.010534556373432, + "cost": 0.000342194841184, + "unitPrice": 3.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByDepartment.json new file mode 100644 index 000000000000..3f6699a3d3ea --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByDepartment.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/Departments/1234", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.8234, + "effectivePrice": 0.010534556373432, + "cost": 0.000342194841184, + "unitPrice": 3.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json new file mode 100644 index 000000000000..d6fa5d76751f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "scope": "providers/Microsoft.Billing/EnrollmentAccounts/1234", + "billingPeriodName": "201903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.8234, + "effectivePrice": 0.010534556373432, + "cost": 0.000342194841184, + "unitPrice": 3.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByManagementGroup.json new file mode 100644 index 000000000000..a490226ef9ab --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2024-08-01/examples/UsageDetailsListForBillingPeriodByManagementGroup.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201903", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1", + "name": "usageDetails_Id1", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 1", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 1", + "accountName": "Account Name 1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 1", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 1", + "partNumber": "Part Number 1", + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": null, + "quantity": 0.8234, + "effectivePrice": 0.010534556373432, + "cost": 0.000342194841184, + "unitPrice": 3.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1", + "resourceName": "Resource Name 1", + "invoiceSection": "Invoice Section 1", + "costCenter": "DEV", + "resourceGroup": "Resource Group 1", + "offerId": "Offer Id 1", + "isAzureCreditEligible": false, + "chargeType": "Usage", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + }, + { + "id": "/scope/providers/Microsoft.Billing/billingPeriods/billingPeriodName/providers/Microsoft.Consumption/usageDetails/usageDetails_Id2", + "name": "usageDetails_Id2", + "type": "Microsoft.Consumption/usageDetails", + "kind": "legacy", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingAccountId": "xxxxxxxx", + "billingAccountName": "Account Name 2", + "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z", + "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z", + "billingProfileId": "xxxxxxxx", + "billingProfileName": "Account Name 2", + "accountName": "Account Name 2", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Subscription Name 2", + "date": "2019-03-30T00:00:00.0000000Z", + "product": "Product Name 2", + "partNumber": "Part Number 2", + "meterId": "11111111-1111-1111-1111-111111111111", + "meterDetails": null, + "quantity": 0.4759, + "effectivePrice": 0.073488920944598, + "cost": 0.000821821271948, + "unitPrice": 5.74, + "billingCurrency": "CAD", + "resourceLocation": "USEast", + "consumedService": "Microsoft.Storage", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 2/providers/Microsoft.Storage/storageAccounts/Resource Name 2", + "resourceName": "Resource Name 2", + "invoiceSection": "Invoice Section 2", + "costCenter": "DEV", + "resourceGroup": "Resource Group 2", + "offerId": "Offer Id 2", + "isAzureCreditEligible": false, + "chargeType": "UnusedReservation", + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitName": "Reservation_purchase_03-09-2018_10-59" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/readme.md b/specification/consumption/resource-manager/readme.md index 5a2f97a06d0a..7796373b4525 100644 --- a/specification/consumption/resource-manager/readme.md +++ b/specification/consumption/resource-manager/readme.md @@ -26,9 +26,18 @@ These are the global settings for the Consumption API. ``` yaml openapi-type: arm -tag: package-2023-11 +tag: package-2024-08 ``` +### Tag: package-2024-08 + +These settings apply only when `--tag=package-2024-08` is specified on the command line. + +```yaml $(tag) == 'package-2024-08' +input-file: + - Microsoft.Consumption/stable/2024-08-01/consumption_pricesheet.json + - Microsoft.Consumption/stable/2024-08-01/consumption.json +``` ### Tag: package-2023-11 diff --git a/specification/consumption/resource-manager/readme.typescript.md b/specification/consumption/resource-manager/readme.typescript.md index 616ad88356e8..d922fa98d8fd 100644 --- a/specification/consumption/resource-manager/readme.typescript.md +++ b/specification/consumption/resource-manager/readme.typescript.md @@ -9,4 +9,10 @@ typescript: package-name: "@azure/arm-consumption" output-folder: "$(typescript-sdks-folder)/sdk/consumption/arm-consumption" generate-metadata: true + +directive: + - from: consumption_pricesheet.json + where: $.paths["/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/download"].post.responses.default.schema + transform: > + $["$ref"] = "consumption.json#/definitions/ErrorResponse"; ``` diff --git a/specification/consumption/resource-manager/sdk-suppressions.yaml b/specification/consumption/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..b3e04668d207 --- /dev/null +++ b/specification/consumption/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,93 @@ +suppressions: + azure-sdk-for-go: + - package: 'sdk/resourcemanager/consumption/armconsumption' + breaking-changes: + - Field `Etag`, `Tags` of struct `CreditSummary` has been removed + - Field `MarketplaceCharges` of struct `LegacyChargeSummaryProperties` has been removed + - Type of `ModernReservationRecommendation.Properties` has been changed from `*ModernReservationRecommendationProperties` to `ModernReservationRecommendationPropertiesClassification` + azure-sdk-for-js: + - package: '@azure/arm-consumption' + breaking-changes: + - Class ConsumptionManagementClient has a new signature + - Interface BudgetFilter no longer has parameter not + - Interface LegacyChargeSummary no longer has parameter marketplaceCharges + - Operation ReservationRecommendationDetails.get has a new signature + - Parameter scope of interface ModernReservationRecommendation is now required + azure-sdk-for-python: + - package: azure-mgmt-consumption + breaking-changes: + - The 'Amount' method 'validate' was deleted or renamed in the current version + - The 'AmountWithExchangeRate' method 'validate' was deleted or renamed in the current version + - The 'Balance' method 'validate' was deleted or renamed in the current version + - The 'BalancePropertiesAdjustmentDetailsItem' method 'validate' was deleted or renamed in the current version + - The 'BalancePropertiesNewPurchasesDetailsItem' method 'validate' was deleted or renamed in the current version + - The 'Budget' method 'validate' was deleted or renamed in the current version + - The 'BudgetComparisonExpression' method 'validate' was deleted or renamed in the current version + - The 'BudgetFilter' method 'validate' was deleted or renamed in the current version + - The 'BudgetFilterProperties' method 'validate' was deleted or renamed in the current version + - The 'BudgetOperatorType' enum had its value 'IN_ENUM' deleted or renamed in the current version + - The 'BudgetTimePeriod' method 'validate' was deleted or renamed in the current version + - The 'BudgetsListResult' method 'validate' was deleted or renamed in the current version + - The 'ChargeSummary' method 'validate' was deleted or renamed in the current version + - The 'ChargesListResult' method 'validate' was deleted or renamed in the current version + - The 'CreditBalanceSummary' method 'validate' was deleted or renamed in the current version + - The 'CreditSummary' method 'validate' was deleted or renamed in the current version + - The 'CurrentSpend' method 'validate' was deleted or renamed in the current version + - The 'DownloadProperties' method 'validate' was deleted or renamed in the current version + - The 'ErrorDetails' method 'validate' was deleted or renamed in the current version + - The 'ErrorResponse' method 'validate' was deleted or renamed in the current version + - The 'EventSummary' method 'validate' was deleted or renamed in the current version + - The 'Events' method 'validate' was deleted or renamed in the current version + - The 'ForecastSpend' method 'validate' was deleted or renamed in the current version + - The 'HighCasedErrorDetails' method 'validate' was deleted or renamed in the current version + - The 'HighCasedErrorResponse' method 'validate' was deleted or renamed in the current version + - The 'LegacyChargeSummary' method 'validate' was deleted or renamed in the current version + - The 'LegacyReservationRecommendation' method 'validate' was deleted or renamed in the current version + - The 'LegacyReservationRecommendationProperties' method 'validate' was deleted or renamed in the current version + - The 'LegacyReservationTransaction' method 'validate' was deleted or renamed in the current version + - The 'LegacySharedScopeReservationRecommendationProperties' method 'validate' was deleted or renamed in the current version + - The 'LegacySingleScopeReservationRecommendationProperties' method 'validate' was deleted or renamed in the current version + - The 'LegacyUsageDetail' method 'validate' was deleted or renamed in the current version + - The 'LotSummary' method 'validate' was deleted or renamed in the current version + - The 'Lots' method 'validate' was deleted or renamed in the current version + - The 'ManagementGroupAggregatedCostResult' method 'validate' was deleted or renamed in the current version + - The 'Marketplace' method 'validate' was deleted or renamed in the current version + - The 'MarketplacesListResult' method 'validate' was deleted or renamed in the current version + - The 'MeterDetails' method 'validate' was deleted or renamed in the current version + - The 'MeterDetailsResponse' method 'validate' was deleted or renamed in the current version + - The 'ModernChargeSummary' method 'validate' was deleted or renamed in the current version + - The 'ModernReservationRecommendation' method 'validate' was deleted or renamed in the current version + - The 'ModernReservationTransaction' method 'validate' was deleted or renamed in the current version + - The 'ModernReservationTransactionsListResult' method 'validate' was deleted or renamed in the current version + - The 'ModernUsageDetail' method 'validate' was deleted or renamed in the current version + - The 'Notification' method 'validate' was deleted or renamed in the current version + - The 'Operation' method 'validate' was deleted or renamed in the current version + - The 'OperationDisplay' method 'validate' was deleted or renamed in the current version + - The 'OperationListResult' method 'validate' was deleted or renamed in the current version + - The 'PriceSheetProperties' method 'validate' was deleted or renamed in the current version + - The 'PriceSheetResult' method 'validate' was deleted or renamed in the current version + - The 'ProxyResource' method 'validate' was deleted or renamed in the current version + - The 'Reseller' method 'validate' was deleted or renamed in the current version + - The 'ReservationDetail' method 'validate' was deleted or renamed in the current version + - The 'ReservationDetailsListResult' method 'validate' was deleted or renamed in the current version + - The 'ReservationRecommendation' method 'validate' was deleted or renamed in the current version + - The 'ReservationRecommendationDetailsCalculatedSavingsProperties' method 'validate' was deleted or renamed in the current version + - The 'ReservationRecommendationDetailsModel' method 'validate' was deleted or renamed in the current version + - The 'ReservationRecommendationDetailsResourceProperties' method 'validate' was deleted or renamed in the current version + - The 'ReservationRecommendationDetailsSavingsProperties' method 'validate' was deleted or renamed in the current version + - The 'ReservationRecommendationDetailsUsageProperties' method 'validate' was deleted or renamed in the current version + - The 'ReservationRecommendationsListResult' method 'validate' was deleted or renamed in the current version + - The 'ReservationSummariesListResult' method 'validate' was deleted or renamed in the current version + - The 'ReservationSummary' method 'validate' was deleted or renamed in the current version + - The 'ReservationTransaction' method 'validate' was deleted or renamed in the current version + - The 'ReservationTransactionResource' method 'validate' was deleted or renamed in the current version + - The 'ReservationTransactionsListResult' method 'validate' was deleted or renamed in the current version + - The 'Resource' method 'validate' was deleted or renamed in the current version + - The 'ResourceAttributes' method 'validate' was deleted or renamed in the current version + - The 'SkuProperty' method 'validate' was deleted or renamed in the current version + - The 'Tag' method 'validate' was deleted or renamed in the current version + - The 'TagsResult' method 'validate' was deleted or renamed in the current version + - The 'UsageDetail' method 'validate' was deleted or renamed in the current version + - The 'UsageDetailsListResult' method 'validate' was deleted or renamed in the current version + - The model or publicly exposed class 'CreditSummary' had its instance variable 'e_tag' deleted or renamed in the current version + - The model or publicly exposed class 'LegacyChargeSummary' had its instance variable 'marketplace_charges' deleted or renamed in the current version From 29e455d11cec7ed4450d08d5b61ae09b4c038965 Mon Sep 17 00:00:00 2001 From: curiekim00 Date: Tue, 27 Aug 2024 10:26:52 -0700 Subject: [PATCH 14/30] Add Microsoft.Databricks 2024-09-01-preview version (#30175) * Copy files from stable/2024-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-09-01-preview Updated the API version from stable/2024-05-01 to preview/2024-09-01-preview. * Added tag for 2024-09-01-preview in readme file * Add Cyber Essential Plus to ComplianceStandardDefinitions * remove the access connector changes * update readme for the access connector stable version * Add description and specify Cyber_essential_plus is only available for uk regions * Update API version for Access Connector * Update sdk-suppressions.yaml * Update sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan --- .../2024-09-01-preview/accessconnector.json | 413 ++++ .../2024-09-01-preview/databricks.json | 1991 +++++++++++++++++ .../AccessConnectorCreateOrUpdate.json | 54 + ...nnectorCreateOrUpdateWithUserAssigned.json | 65 + .../examples/AccessConnectorDelete.json | 19 + .../examples/AccessConnectorGet.json | 31 + .../examples/AccessConnectorPatchUpdate.json | 42 + .../AccessConnectorsListByResourceGroup.json | 48 + .../AccessConnectorsListBySubscriptionId.json | 79 + .../examples/DisableEncryption.json | 132 ++ .../examples/EnableEncryption.json | 141 ++ .../ListPrivateEndpointConnections.json | 32 + .../examples/ListPrivateLinkResources.json | 30 + .../examples/OperationsList.json | 128 ++ ...boundNetworkDependenciesEndpointsList.json | 120 + .../examples/PrepareEncryption.json | 100 + .../PrivateEndpointConnectionsDelete.json | 20 + .../PrivateEndpointConnectionsGet.json | 29 + .../PrivateEndpointConnectionsUpdate.json | 55 + .../examples/PrivateLinkResourcesGet.json | 27 + .../examples/WorkspaceCreate.json | 114 + .../WorkspaceCreateWithParameters.json | 146 ++ .../examples/WorkspaceDelete.json | 19 + .../WorkspaceDeleteForceDeletion.json | 20 + ...ancedSecurityComplianceCreateOrUpdate.json | 134 ++ ...orkspaceEnhancedSecurityComplianceGet.json | 62 + .../examples/WorkspaceGet.json | 48 + .../examples/WorkspaceGetParameters.json | 81 + .../WorkspaceManagedDiskEncryptionCreate.json | 142 ++ .../WorkspaceManagedDiskEncryptionGet.json | 67 + .../WorkspaceManagedDiskEncryptionUpdate.json | 150 ++ .../examples/WorkspaceUpdate.json | 62 + .../WorkspaceVirtualNetPeeringGet.json | 43 + .../WorkspaceVirtualNetPeeringList.json | 45 + ...ceVirtualNetworkPeeringCreateOrUpdate.json | 84 + .../WorkspaceVirtualNetworkPeeringDelete.json | 19 + .../WorkspacesListByResourceGroup.json | 87 + .../WorkspacesListBySubscription.json | 87 + .../2024-09-01-preview/vnetpeering.json | 465 ++++ .../databricks/resource-manager/readme.md | 28 +- .../resource-manager/sdk-suppressions.yaml | 7 +- 41 files changed, 5464 insertions(+), 2 deletions(-) create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/accessconnector.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/databricks.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdateWithUserAssigned.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorDelete.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorPatchUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListByResourceGroup.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListBySubscriptionId.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/DisableEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/EnableEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateEndpointConnections.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateLinkResources.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OperationsList.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrepareEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateLinkResourcesGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreateWithParameters.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDelete.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDeleteForceDeletion.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGetParameters.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringList.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListByResourceGroup.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListBySubscription.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/vnetpeering.json diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/accessconnector.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/accessconnector.json new file mode 100644 index 000000000000..c3e4f8d92974 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/accessconnector.json @@ -0,0 +1,413 @@ +{ + "swagger": "2.0", + "info": { + "title": "DatabricksAccessConnectorClient", + "version": "2024-09-01-preview", + "description": "These APIs allow end users to operate on Azure Databricks Access Connector resources." + }, + "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.Databricks/accessConnectors/{connectorName}": { + "get": { + "tags": [ + "AccessConnector" + ], + "operationId": "AccessConnectors_Get", + "description": "Gets an Azure Databricks Access Connector.", + "x-ms-examples": { + "Get an Azure Databricks Access Connector": { + "$ref": "./examples/AccessConnectorGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConnectorName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the Access Connector.", + "schema": { + "$ref": "#/definitions/AccessConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2022-04-01-preview/databricks.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AccessConnector" + ], + "operationId": "AccessConnectors_Delete", + "description": "Deletes the Azure Databricks Access Connector.", + "x-ms-examples": { + "Delete an Azure Databricks Access Connector": { + "$ref": "./examples/AccessConnectorDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConnectorName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "NoContent" + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2022-04-01-preview/databricks.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "AccessConnector" + ], + "operationId": "AccessConnectors_CreateOrUpdate", + "description": "Creates or updates Azure Databricks Access Connector.", + "x-ms-examples": { + "Create an Azure Databricks Access Connector with SystemAssigned Identity": { + "$ref": "./examples/AccessConnectorCreateOrUpdate.json" + }, + "Create an Azure Databricks Access Connector with UserAssigned Identity": { + "$ref": "./examples/AccessConnectorCreateOrUpdateWithUserAssigned.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessConnector" + }, + "description": "Parameters supplied to the create or update an Azure Databricks Access Connector." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConnectorName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the Azure Databricks Access Connector.", + "schema": { + "$ref": "#/definitions/AccessConnector" + } + }, + "201": { + "description": "Created - Returns information about the Azure Databricks Access Connector.", + "schema": { + "$ref": "#/definitions/AccessConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2022-04-01-preview/databricks.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "AccessConnector" + ], + "operationId": "AccessConnectors_Update", + "description": "Updates an Azure Databricks Access Connector.", + "x-ms-examples": { + "Update an Azure Databricks Access Connector": { + "$ref": "./examples/AccessConnectorPatchUpdate.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessConnectorUpdate" + }, + "description": "The update to the Azure Databricks Access Connector." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConnectorName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "200": { + "description": "Successfully updated the Azure Databricks Access Connector.", + "schema": { + "$ref": "#/definitions/AccessConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2022-04-01-preview/databricks.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/accessConnectors": { + "get": { + "tags": [ + "AccessConnector" + ], + "operationId": "AccessConnectors_ListByResourceGroup", + "description": "Gets all the Azure Databricks Access Connectors within a resource group.", + "x-ms-examples": { + "Lists Azure Databricks Access Connectors within a resource group": { + "$ref": "./examples/AccessConnectorsListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of Azure Databricks Access Connectors.", + "schema": { + "$ref": "#/definitions/AccessConnectorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2022-04-01-preview/databricks.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Databricks/accessConnectors": { + "get": { + "tags": [ + "AccessConnector" + ], + "operationId": "AccessConnectors_ListBySubscription", + "description": "Gets all the Azure Databricks Access Connectors within a subscription.", + "x-ms-examples": { + "Lists all the Azure Databricks Access Connectors within a subscription.": { + "$ref": "./examples/AccessConnectorsListBySubscriptionId.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of Azure Databricks Access Connectors.", + "schema": { + "$ref": "#/definitions/AccessConnectorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2022-04-01-preview/databricks.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AccessConnector": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "systemData": { + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + }, + "properties": { + "description": "Azure Databricks Access Connector properties", + "$ref": "#/definitions/AccessConnectorProperties" + } + }, + "allOf": [ + { + "$ref": "../../preview/2022-04-01-preview/databricks.json#/definitions/TrackedResource" + } + ], + "description": "Information about Azure Databricks Access Connector." + }, + "AccessConnectorProperties": { + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning status of the Access Connector.", + "readOnly": true, + "enum": [ + "Deleted", + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "referedBy": { + "description": "List of workspaces referring this Access Connector.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AccessConnectorUpdate": { + "description": "An update to an Azure Databricks Access Connector.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "AccessConnectorListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessConnector" + }, + "description": "The array of Azure Databricks Access Connector." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of Azure Databricks Access Connector." + } + }, + "parameters": { + "ConnectorName": { + "name": "connectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Databricks Access Connector.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/databricks.json new file mode 100644 index 000000000000..7600663b3647 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/databricks.json @@ -0,0 +1,1991 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureDatabricksManagementClient", + "version": "2024-09-01-preview", + "description": "These APIs allow end users to operate on Azure Databricks Workspace resources." + }, + "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.Databricks/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Get", + "description": "Gets the workspace.", + "x-ms-examples": { + "Get a workspace": { + "$ref": "./examples/WorkspaceGet.json" + }, + "Get a workspace with custom parameters": { + "$ref": "./examples/WorkspaceGetParameters.json" + }, + "Get a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": { + "$ref": "./examples/WorkspaceManagedDiskEncryptionGet.json" + }, + "Get a workspace with Enhanced Security & Compliance Add-On": { + "$ref": "./examples/WorkspaceEnhancedSecurityComplianceGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Delete", + "description": "Deletes the workspace.", + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/WorkspaceDelete.json" + }, + "Delete a workspace with forceDeletion parameter": { + "$ref": "./examples/WorkspaceDeleteForceDeletion.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "Optional parameter to retain default unity catalog data. By default the data will retained if Uc is enabled on the workspace." + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Creates a new workspace.", + "x-ms-examples": { + "Create or update workspace": { + "$ref": "./examples/WorkspaceCreate.json" + }, + "Create or update workspace with custom parameters": { + "$ref": "./examples/WorkspaceCreateWithParameters.json" + }, + "Create a workspace which is ready for Customer-Managed Key (CMK) encryption": { + "$ref": "./examples/PrepareEncryption.json" + }, + "Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption": { + "$ref": "./examples/EnableEncryption.json" + }, + "Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace": { + "$ref": "./examples/DisableEncryption.json" + }, + "Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": { + "$ref": "./examples/WorkspaceManagedDiskEncryptionCreate.json" + }, + "Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": { + "$ref": "./examples/WorkspaceManagedDiskEncryptionUpdate.json" + }, + "Create or update a workspace with Enhanced Security & Compliance Add-On": { + "$ref": "./examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "Parameters supplied to the create or update a workspace." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Created - Returns information about the workspace, including provisioning status.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Created - Returns information about the workspace, including provisioning status.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Update", + "description": "Updates a workspace.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdate" + }, + "description": "The update to the workspace." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a workspace's tags.": { + "$ref": "./examples/WorkspaceUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "Gets all the workspaces within a resource group.", + "x-ms-examples": { + "Lists workspaces": { + "$ref": "./examples/WorkspacesListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of workspaces.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "Gets all the workspaces within a subscription.", + "x-ms-examples": { + "Lists workspaces": { + "$ref": "./examples/WorkspacesListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of workspaces.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Databricks/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available RP operations.", + "x-ms-examples": { + "Operations": { + "$ref": "./examples/OperationsList.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "List private link resources", + "description": "List private link resources for a given workspace", + "operationId": "PrivateLinkResources_List", + "x-ms-examples": { + "List private link resources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given group id (sub-resource)", + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "Get a private link resource": { + "$ref": "./examples/PrivateLinkResourcesGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupId" + } + ], + "responses": { + "200": { + "description": "OK - Returns the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connections of the workspace", + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "List private endpoint connections": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns list of private endpoint connections for a workspace", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Get private endpoint connection", + "description": "Get a private endpoint connection properties for a workspace", + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "Get a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK - Returns the private endpoint connection properties of a workspace", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PUT", + "PrivateEndpointConnections" + ], + "summary": "Update private endpoint connection status", + "description": "Update the status of a private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Create", + "x-ms-examples": { + "Update a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DELETE", + "PrivateEndpointConnections" + ], + "summary": "Remove private endpoint connection", + "description": "Remove private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "Remove a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation." + }, + "200": { + "description": "OK - Returns the status of polling request for the delete operation." + }, + "204": { + "description": "No Content - PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified Workspace.", + "description": "Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You must configure outbound access with these endpoints. For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr", + "operationId": "OutboundNetworkDependenciesEndpoints_List", + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Workspace": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response contains list of outbound network dependency endpoints", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Workspace": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties", + "description": "The workspace properties." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the resource." + }, + "systemData": { + "description": "The system metadata relating to this resource", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Information about workspace." + }, + "WorkspaceProperties": { + "properties": { + "managedResourceGroupId": { + "type": "string", + "description": "The managed resource group Id." + }, + "parameters": { + "$ref": "#/definitions/WorkspaceCustomParameters", + "description": "The workspace's custom parameters." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The workspace provisioning state." + }, + "uiDefinitionUri": { + "type": "string", + "description": "The blob URI where the UI definition file is located." + }, + "authorizations": { + "description": "The workspace provider authorizations.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/WorkspaceProviderAuthorization" + } + }, + "createdBy": { + "description": "Indicates the Object ID, PUID and Application ID of entity that created the workspace.", + "$ref": "#/definitions/CreatedBy" + }, + "updatedBy": { + "description": "Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.", + "$ref": "#/definitions/CreatedBy" + }, + "createdDateTime": { + "description": "Specifies the date and time when the workspace is created.", + "$ref": "#/definitions/CreatedDateTime" + }, + "workspaceId": { + "readOnly": true, + "description": "The unique identifier of the databricks workspace in databricks control plane.", + "type": "string" + }, + "workspaceUrl": { + "readOnly": true, + "description": "The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'", + "type": "string" + }, + "storageAccountIdentity": { + "description": "The details of Managed Identity of Storage Account", + "$ref": "#/definitions/ManagedIdentityConfiguration" + }, + "managedDiskIdentity": { + "description": "The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption", + "$ref": "#/definitions/ManagedIdentityConfiguration" + }, + "diskEncryptionSetId": { + "readOnly": true, + "type": "string", + "description": "The resource Id of the managed disk encryption set." + }, + "encryption": { + "type": "object", + "description": "Encryption properties for databricks workspace", + "properties": { + "entities": { + "$ref": "#/definitions/EncryptionEntitiesDefinition", + "description": "Encryption entities definition for the workspace." + } + }, + "required": [ + "entities" + ] + }, + "enhancedSecurityCompliance": { + "description": "Contains settings related to the Enhanced Security and Compliance Add-On.", + "$ref": "#/definitions/EnhancedSecurityComplianceDefinition" + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "Private endpoint connections created on the workspace", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "requiredNsgRules": { + "type": "string", + "description": "Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.", + "enum": [ + "AllRules", + "NoAzureDatabricksRules", + "NoAzureServiceRules" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RequiredNsgRules" + } + }, + "defaultCatalog": { + "description": "Properties for Default Catalog configuration during workspace creation.", + "$ref": "#/definitions/DefaultCatalogProperties" + }, + "isUcEnabled": { + "readOnly": true, + "description": "Indicates whether unity catalog enabled for the workspace or not.", + "type": "boolean" + }, + "accessConnector": { + "description": "Access Connector Resource that is going to be associated with Databricks Workspace", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of Azure Databricks Access Connector Resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Databricks/accessConnectors" + } + ] + } + }, + "identityType": { + "type": "string", + "description": "The identity type of the Access Connector Resource.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "IdentityType" + } + }, + "userAssignedIdentityId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + }, + "required": [ + "id", + "identityType" + ] + }, + "defaultStorageFirewall": { + "description": "Gets or Sets Default Storage Firewall configuration information", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "defaultStorageFirewall" + } + } + }, + "required": [ + "managedResourceGroupId" + ], + "description": "The workspace properties." + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The SKU name." + }, + "tier": { + "type": "string", + "description": "The SKU tier." + } + }, + "required": [ + "name" + ], + "description": "SKU for the resource." + }, + "ProvisioningState": { + "description": "Provisioning status of the workspace.", + "readOnly": true, + "enum": [ + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "PeeringProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PeeringProvisioningState", + "modelAsString": true + } + }, + "ManagedIdentityConfiguration": { + "description": "The Managed Identity details for storage account.", + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The objectId of the Managed Identity that is linked to the Managed Storage account.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant Id where the Managed Identity is created.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of Identity created. It can be either SystemAssigned or UserAssigned.", + "readOnly": true + } + } + }, + "EnhancedSecurityComplianceDefinition": { + "type": "object", + "description": "Status of settings related to the Enhanced Security and Compliance Add-On.", + "properties": { + "automaticClusterUpdate": { + "type": "string", + "description": "Status of automated cluster updates feature.", + "$ref": "#/definitions/AutomaticClusterUpdateDefinition" + }, + "complianceSecurityProfile": { + "type": "object", + "description": "Status of Compliance Security Profile feature.", + "$ref": "#/definitions/ComplianceSecurityProfileDefinition" + }, + "enhancedSecurityMonitoring": { + "type": "object", + "description": "Status of Enhanced Security Monitoring feature.", + "$ref": "#/definitions/EnhancedSecurityMonitoringDefinition" + } + } + }, + "AutomaticClusterUpdateDefinition": { + "type": "object", + "description": "Status of automated cluster updates feature.", + "properties": { + "value": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AutomaticClusterUpdateValue" + } + } + } + }, + "EnhancedSecurityMonitoringDefinition": { + "type": "object", + "description": "Status of Enhanced Security Monitoring feature.", + "properties": { + "value": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "EnhancedSecurityMonitoringValue" + } + } + } + }, + "ComplianceSecurityProfileDefinition": { + "type": "object", + "description": "Status of Compliance Security Profile feature.", + "properties": { + "complianceStandards": { + "description": "Compliance standards associated with the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/ComplianceStandardDefinition" + } + }, + "value": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ComplianceSecurityProfileValue" + } + } + } + }, + "ComplianceStandardDefinition": { + "description": "Compliance standard that can be associated with a workspace. CYBER_ESSENTIAL_PLUS is only available for UK region workspaces", + "type": "string", + "enum": [ + "NONE", + "HIPAA", + "PCI_DSS", + "CYBER_ESSENTIAL_PLUS" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ComplianceStandard" + } + }, + "WorkspaceCustomParameterType": { + "description": "Provisioning status of the workspace.", + "readOnly": true, + "enum": [ + "Bool", + "Object", + "String" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomParameterType", + "modelAsString": true + } + }, + "WorkspaceNoPublicIPBooleanParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "boolean", + "description": "The value which should be used for this field." + } + }, + "type": "object", + "required": [ + "value" + ], + "description": "The value which should be used for this field." + }, + "WorkspaceCustomBooleanParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "boolean", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The value which should be used for this field." + }, + "WorkspaceCustomObjectParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "object", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The value which should be used for this field." + }, + "WorkspaceCustomStringParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "string", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The Value." + }, + "WorkspaceCustomParameters": { + "properties": { + "amlWorkspaceId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The ID of a Azure Machine Learning workspace to link with Databricks workspace" + }, + "customVirtualNetworkId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The ID of a Virtual Network where this Databricks Cluster should be created" + }, + "customPublicSubnetName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The name of a Public Subnet within the Virtual Network" + }, + "customPrivateSubnetName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The name of the Private Subnet within the Virtual Network" + }, + "enableNoPublicIp": { + "$ref": "#/definitions/WorkspaceNoPublicIPBooleanParameter", + "description": "Boolean indicating whether the public IP should be disabled. Default value is true" + }, + "loadBalancerBackendPoolName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP)." + }, + "loadBalancerId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace." + }, + "natGatewayName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets." + }, + "publicIpName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the Public IP for No Public IP workspace with managed vNet." + }, + "prepareEncryption": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "Prepare the workspace for encryption. Enables the Managed Identity for managed storage account." + }, + "encryption": { + "$ref": "#/definitions/WorkspaceEncryptionParameter", + "description": "Contains the encryption details for Customer-Managed Key (CMK) enabled workspace." + }, + "requireInfrastructureEncryption": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest." + }, + "storageAccountName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Default DBFS storage account name." + }, + "storageAccountSkuName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs." + }, + "vnetAddressPrefix": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Address prefix for Managed virtual network. Default value for this input is 10.139." + }, + "resourceTags": { + "$ref": "#/definitions/WorkspaceCustomObjectParameter", + "readOnly": true, + "description": "Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level." + } + }, + "description": "Custom Parameters used for Cluster Creation." + }, + "CreatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time stamp when the workspace was created.", + "readOnly": true + }, + "CreatedBy": { + "properties": { + "oid": { + "type": "string", + "format": "uuid", + "description": "The Object ID that created the workspace.", + "readOnly": true + }, + "puid": { + "type": "string", + "description": "The Personal Object ID corresponding to the object ID above", + "readOnly": true + }, + "applicationId": { + "type": "string", + "format": "uuid", + "description": "The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.", + "readOnly": true + } + }, + "description": "Provides details of the entity that created/updated the workspace." + }, + "WorkspaceEncryptionParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "$ref": "#/definitions/Encryption", + "description": "The value which should be used for this field." + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, + "Encryption": { + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault", + "enum": [ + "Default", + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true + }, + "default": "Default" + }, + "KeyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyversion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyvaulturi": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri" + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, + "DefaultCatalogProperties": { + "type": "object", + "properties": { + "initialType": { + "type": "string", + "description": "Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog", + "enum": [ + "HiveMetastore", + "UnityCatalog" + ], + "x-ms-enum": { + "name": "initialType", + "modelAsString": true + }, + "default": "HiveMetastore" + }, + "initialName": { + "type": "string", + "description": "Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used." + } + }, + "description": "These properties lets user specify default catalog properties during workspace creation." + }, + "EncryptionEntitiesDefinition": { + "properties": { + "managedServices": { + "type": "object", + "description": "Encryption properties for the databricks managed services.", + "$ref": "#/definitions/EncryptionV2" + }, + "managedDisk": { + "type": "object", + "description": "Encryption properties for the databricks managed disks.", + "$ref": "#/definitions/ManagedDiskEncryption" + } + }, + "description": "Encryption entities for databricks workspace resource." + }, + "EncryptionV2": { + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault", + "enum": [ + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true + } + }, + "keyVaultProperties": { + "properties": { + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVersion": { + "type": "string", + "description": "The version of KeyVault key." + } + }, + "required": [ + "keyVaultUri", + "keyName", + "keyVersion" + ], + "description": "Key Vault input properties for encryption." + } + }, + "required": [ + "keySource" + ], + "description": "The object that contains details of encryption used on the workspace." + }, + "ManagedDiskEncryption": { + "type": "object", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault", + "enum": [ + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true + } + }, + "keyVaultProperties": { + "type": "object", + "properties": { + "keyVaultUri": { + "type": "string", + "description": "The URI of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVersion": { + "type": "string", + "description": "The version of KeyVault key." + } + }, + "required": [ + "keyVaultUri", + "keyName", + "keyVersion" + ], + "description": "Key Vault input properties for encryption." + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Indicate whether the latest key version should be automatically used for Managed Disk Encryption." + } + }, + "required": [ + "keySource", + "keyVaultProperties" + ], + "description": "The object that contains details of encryption used on the workspace." + }, + "WorkspaceProviderAuthorization": { + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources." + }, + "roleDefinitionId": { + "type": "string", + "format": "uuid", + "description": "The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group." + } + }, + "required": [ + "principalId", + "roleDefinitionId" + ], + "description": "The workspace provider authorization." + }, + "WorkspaceUpdate": { + "description": "An update to a workspace.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ErrorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorResponse": { + "title": "Error response.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/ErrorInfo" + } + }, + "required": [ + "error" + ] + }, + "WorkspaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + }, + "description": "The array of workspaces." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of workspaces." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: ex Microsoft.Databricks", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description for the resource operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Resource Provider operations supported by the Resource Provider resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "PrivateLinkResourcesList": { + "description": "The available private link resources for a workspace", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for a workspace", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of private link resources." + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on a workspace", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The group id properties.", + "type": "object", + "x-ms-client-flatten": false, + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "List of private link connections.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of returned private endpoint connection." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of endpoint connections." + } + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of a workspace", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "type": "object", + "description": "The private endpoint connection properties.", + "x-ms-client-flatten": false, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "title": "Private endpoint", + "description": "Private endpoint", + "$ref": "#/definitions/PrivateEndpoint" + }, + "groupIds": { + "type": "array", + "description": "GroupIds from the private link service resource.", + "items": { + "type": "string" + } + }, + "privateLinkServiceConnectionState": { + "title": "Private link service service connection state", + "description": "Private endpoint connection state", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "Provisioning state of the private endpoint connection." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status" + ] + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "EndpointDependency": { + "description": "A domain name or IP address the Workspace is reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports used when connecting to domainName.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/EndpointDetail" + } + } + } + }, + "EndpointDetail": { + "description": "Connect information from the Workspace to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "latency": { + "format": "double", + "description": "The time in milliseconds it takes for the connection to be created from the Workspace to this IpAddress at this Port.", + "type": "number" + }, + "isAccessible": { + "description": "Whether it is possible to create a connection from the Workspace to this IpAddress at this Port.", + "type": "boolean" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which Workspace connects to for common purposes.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the Workspace, e.g. azure-storage, azure-mysql, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that Workspace connect to", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/EndpointDependency" + } + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of outbound network dependency endpoints", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + } + } + }, + "parameters": { + "WorkspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "PeeringNameParameter": { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace vNet peering.", + "x-ms-parameter-location": "method" + }, + "GroupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdate.json new file mode 100644 index 000000000000..b342ae803e80 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "connectorName": "myAccessConnector", + "api-version": "2024-09-01-preview", + "identity": { + "type": "SystemAssigned" + }, + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "myAccessConnector", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector2", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "name": "myAccessConnector", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdateWithUserAssigned.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdateWithUserAssigned.json new file mode 100644 index 000000000000..f633178e75be --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorCreateOrUpdateWithUserAssigned.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "connectorName": "myAccessConnector", + "api-version": "2024-09-01-preview", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/11111111-1111-1111-1111-111111111111/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuseridentity": {} + } + }, + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "myAccessConnector", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector2", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/11111111-1111-1111-1111-111111111111/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuseridentity": { + "principalId": "329429bc-adec-4dce-9568-25a6d486e468", + "clientId": "329419bc-adec-4dce-9568-25a6d486e468" + } + } + } + } + }, + "201": { + "body": { + "name": "myAccessConnector", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/11111111-1111-1111-1111-111111111111/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuseridentity": { + "principalId": "329429bc-adec-4dce-9568-25a6d486e468", + "clientId": "329419bc-adec-4dce-9568-25a6d486e468" + } + } + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorDelete.json new file mode 100644 index 000000000000..c164e4597e06 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "connectorName": "myAccessConnector", + "resourceGroupName": "rg", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/accessConnectors/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-05-01", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/accessConnectors/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-05-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorGet.json new file mode 100644 index 000000000000..66b714a5bc6b --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "connectorName": "myAccessConnector", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myAccessConnector", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorPatchUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorPatchUpdate.json new file mode 100644 index 000000000000..6685537e7081 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorPatchUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "connectorName": "myAccessConnector", + "api-version": "2024-09-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/accessConnectors/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-05-01", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/accessConnectors/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-05-01" + } + }, + "200": { + "body": { + "name": "myAccessConnector", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListByResourceGroup.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListByResourceGroup.json new file mode 100644 index 000000000000..5896a31588e5 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myAccessConnector1", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector1", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + }, + { + "name": "myAccessConnector", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector2", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "7ad2bae1-37d0-413e-91f8-b0b7bef807fc", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListBySubscriptionId.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListBySubscriptionId.json new file mode 100644 index 000000000000..a3676d783455 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/AccessConnectorsListBySubscriptionId.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myAccessConnector1", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Databricks/accessConnectors/myAccessConnector1", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "7ad2bae1-37d0-413e-91f8-b0b7bef807fc", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + }, + { + "name": "myAccessConnector2", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Databricks/accessConnectors/myAccessConnector2", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + }, + { + "name": "myAccessConnector3", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg2/providers/Microsoft.Databricks/accessConnectors/myAccessConnector3", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "04b25430-8db1-48a0-9c2f-32270ed63eef", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + }, + { + "name": "myAccessConnector4", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg3/providers/Microsoft.Databricks/accessConnectors/myAccessConnector4", + "type": "Microsoft.Databricks/accessConnectors", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "referedBy": [] + }, + "identity": { + "principalId": "4856ceed-0a99-4df7-b9fc-35603650af06", + "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da", + "type": "SystemAssigned" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/DisableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/DisableEncryption.json new file mode 100644 index 000000000000..30594e4ab81f --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/DisableEncryption.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": { + "encryption": { + "value": { + "keySource": "Default" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Default" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/EnableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/EnableEncryption.json new file mode 100644 index 000000000000..65fbb72a0605 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/EnableEncryption.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + }, + "encryption": { + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateEndpointConnections.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..31bb6123d296 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateLinkResources.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..d97b4e3b585d --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/ListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api", + "name": "databricks_ui_api", + "type": "Microsoft.Databricks/workspaces/PrivateLinkResources", + "properties": { + "groupId": "databricks_ui_api", + "requiredMembers": [ + "databricks_ui_api" + ], + "requiredZoneNames": [ + "privatelink.azuredatabricks.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OperationsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..e6adb4d779ef --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OperationsList.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Databricks/workspaces/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "List Workspaces", + "description": "Retrieves a list of workspaces." + } + }, + { + "name": "Microsoft.Databricks/workspaces/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Create Workspace", + "description": "Creates an workspace." + } + }, + { + "name": "Microsoft.Databricks/workspaces/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Remove Workspace", + "description": "Removes an workspace." + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Get Virtual Network Peering", + "description": "Gets the virtual network peering." + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Add Virtual Network Peering", + "description": "Add or modify virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Delete Virtual Network Peering", + "description": "Deletes a virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateLinkResources/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Link Resources", + "operation": "List Private Link Resources", + "description": "Retrieve List of Private Link Resources" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "List Private Endpoint Connections", + "description": "Retrieve List of Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "Update Private Endpoint Connection", + "description": "Update a virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "Delete Private Endpoint Connection", + "description": "Delete a Private Endpoint Connection" + } + }, + { + "name": "Microsoft.Databricks/accessConnectors/read", + "display": { + "provider": "Azure Databricks", + "resource": "AccessConnector", + "operation": "List Azure Databricks Access Connector", + "description": "Retrieves a list of Azure Databricks Access Connector." + } + }, + { + "name": "Microsoft.Databricks/accessConnectors/write", + "display": { + "provider": "Azure Databricks", + "resource": "AccessConnector", + "operation": "Create Azure Databricks Access Connector", + "description": "Creates an Azure Databricks Access Connector." + } + }, + { + "name": "Microsoft.Databricks/accessConnectors/delete", + "display": { + "provider": "Azure Databricks", + "resource": "AccessConnector", + "operation": "Remove Azure Databricks Access Connector", + "description": "Removes Azure Databricks Access Connector." + } + } + ] + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..6d26901dfce0 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": [ + { + "category": "Webapp", + "endpoints": [ + { + "endpointDetails": [ + { + "ipAddress": "11.111.111.11/11", + "port": 123 + }, + { + "ipAddress": "22.222.222.22/22", + "port": 123 + } + ] + } + ] + }, + { + "category": "Control Plane NAT", + "endpoints": [ + { + "endpointDetails": [ + { + "ipAddress": "33.33.333.333/33", + "port": 123 + } + ] + } + ] + }, + { + "category": "Extended infrastructure", + "endpoints": [ + { + "endpointDetails": [ + { + "ipAddress": "44.44.44.44/44", + "port": 123 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "xxx.blob.core.windows.net", + "endpointDetails": [ + { + "port": 123 + } + ] + }, + { + "domainName": "yyy.blob.core.windows.net", + "endpointDetails": [ + { + "port": 123 + } + ] + }, + { + "domainName": "zzz.blob.core.windows.net", + "endpointDetails": [ + { + "port": 123 + } + ] + } + ] + }, + { + "category": "Azure My SQL", + "endpoints": [ + { + "domainName": "xxx.mysql.database.azure.com", + "endpointDetails": [ + { + "port": 1234 + } + ] + }, + { + "domainName": "yyy.mysql.database.azure.com", + "endpointDetails": [ + { + "port": 1234 + } + ] + } + ] + }, + { + "category": "Azure Servicebus", + "endpoints": [ + { + "domainName": "xxx.servicebus.windows.net", + "endpointDetails": [ + { + "port": 1234 + } + ] + } + ] + } + ] + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrepareEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrepareEncryption.json new file mode 100644 index 000000000000..14c860b14064 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrepareEncryption.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..f095083b8db4 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/locations/exampleLocation/operationStatuses/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/locations/exampleLocation/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..37a1e9d732a6 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..537c5ef194d3 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateLinkResourcesGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..16cf6b3feacd --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/PrivateLinkResourcesGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "groupId": "databricks_ui_api" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api", + "name": "databricks_ui_api", + "type": "Microsoft.Databricks/workspaces/PrivateLinkResources", + "properties": { + "groupId": "databricks_ui_api", + "requiredMembers": [ + "databricks_ui_api" + ], + "requiredZoneNames": [ + "privatelink.azuredatabricks.net" + ] + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreate.json new file mode 100644 index 000000000000..f2fc86719d6a --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreate.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "defaultCatalog": { + "initialType": "UnityCatalog", + "initialName": "" + }, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "SystemAssigned" + }, + "defaultStorageFirewall": "Enabled" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "SystemAssigned" + }, + "defaultStorageFirewall": "Enabled", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "defaultCatalog": { + "initialType": "UnityCatalog", + "initialName": "" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "SystemAssigned" + }, + "defaultStorageFirewall": "Enabled", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreateWithParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreateWithParameters.json new file mode 100644 index 000000000000..94802e80ff0a --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceCreateWithParameters.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "defaultCatalog": { + "initialType": "HiveMetastore", + "initialName": "" + }, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "UserAssigned", + "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + }, + "defaultStorageFirewall": "Enabled", + "parameters": { + "customVirtualNetworkId": { + "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "customPublicSubnetName": { + "value": "myPublicSubnet" + }, + "customPrivateSubnetName": { + "value": "myPrivateSubnet" + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "myPrivateSubnet" + }, + "customPublicSubnetName": { + "type": "String", + "value": "myPublicSubnet" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + } + }, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "UserAssigned", + "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + }, + "defaultStorageFirewall": "Enabled", + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "defaultCatalog": { + "initialType": "HiveMetastore", + "initialName": "" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "isUcEnabled": true, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "UserAssigned", + "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + }, + "defaultStorageFirewall": "Enabled", + "defaultCatalog": { + "initialType": "HiveMetastore", + "initialName": "" + } + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDelete.json new file mode 100644 index 000000000000..81e13c726d64 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "rg", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDeleteForceDeletion.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDeleteForceDeletion.json new file mode 100644 index 000000000000..d3154e11a81f --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceDeleteForceDeletion.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "rg", + "api-version": "2024-09-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "forceDeletion": "false" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json new file mode 100644 index 000000000000..3eb15a35732a --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + } + }, + "location": "eastus2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2023-08-24T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2023-08-24T00:10:29.2858439Z", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json new file mode 100644 index 000000000000..6da0e3ea8c29 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2023-08-24T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGet.json new file mode 100644 index 000000000000..579fa4e32f27 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGetParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGetParameters.json new file mode 100644 index 000000000000..0d9f45953caa --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceGetParameters.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace/privateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subscriptionId/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + ], + "publicNetworkAccess": "Disabled", + "requiredNsgRules": "NoAzureDatabricksRules", + "isUcEnabled": false + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json new file mode 100644 index 000000000000..d20d7b8e18dd --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json new file mode 100644 index 000000000000..b4ba8fbb543d --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json new file mode 100644 index 000000000000..824022f9c26b --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + } + }, + "location": "westus", + "tags": { + "mytag1": "myvalue1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "mytag1": "myvalue1" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "mytag1": "myvalue1" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceUpdate.json new file mode 100644 index 000000000000..7a5ab6ccdc75 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceUpdate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-09-01-preview", + "parameters": { + "tags": { + "mytag1": "myvalue1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "mytag1": "myvalue1" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringGet.json new file mode 100644 index 000000000000..88d5e1cfa4ee --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "0140911e-1040-48da-8bc9-b99fb3dd88a6/", + "resourceGroupName": "subramantest", + "workspaceName": "adbworkspace", + "peeringName": "vNetPeeringTest", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringList.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringList.json new file mode 100644 index 000000000000..044abf1cdf30 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetPeeringList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "0140911e-1040-48da-8bc9-b99fb3dd88a6/", + "resourceGroupName": "subramantest", + "workspaceName": "adbworkspace", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json new file mode 100644 index 000000000000..8152ad97c180 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "0140911e-1040-48da-8bc9-b99fb3dd88a6/", + "resourceGroupName": "subramantest", + "workspaceName": "adbworkspace", + "peeringName": "vNetPeeringTest", + "api-version": "2024-09-01-preview", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "allowVirtualNetworkAccess": true, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "useRemoteGateways": false + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Updating" + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..bb441906a30a --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0140911e-1040-48da-8bc9-b99fb3dd88a6/", + "resourceGroupName": "subramantest", + "workspaceName": "adbworkspace", + "peeringName": "vNetPeeringTest", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/providers/Microsoft.Network/locations/exampleLocation/operations/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/providers/Microsoft.Network/locations/exampleLocation/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-09-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListByResourceGroup.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListByResourceGroup.json new file mode 100644 index 000000000000..a956c39f97b1 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListByResourceGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myWorkspace1", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + }, + { + "name": "myWorkspace2", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "standard" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListBySubscription.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListBySubscription.json new file mode 100644 index 000000000000..55b1be77d8c7 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/examples/WorkspacesListBySubscription.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myWorkspace1", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + }, + { + "name": "myWorkspace2", + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "standard" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/vnetpeering.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/vnetpeering.json new file mode 100644 index 000000000000..e1838ad107f9 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-09-01-preview/vnetpeering.json @@ -0,0 +1,465 @@ +{ + "swagger": "2.0", + "info": { + "title": "DatabricksClient", + "version": "2024-09-01-preview", + "description": "ARM Databricks" + }, + "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.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Get", + "description": "Gets the workspace vNet Peering.", + "x-ms-examples": { + "Get a workspace with vNet Peering Configured": { + "$ref": "./examples/WorkspaceVirtualNetPeeringGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "204": { + "description": "OK - NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Delete", + "description": "Deletes the workspace vNetPeering.", + "x-ms-examples": { + "Delete a workspace vNet Peering": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "NoContent" + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_CreateOrUpdate", + "description": "Creates vNet Peering for workspace.", + "x-ms-examples": { + "Create vNet Peering for Workspace": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create workspace vNet Peering." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the workspace vNet peering, including provisioning status.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "200": { + "description": "Update succeeded - Returns information about the workspace vNet peering.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_ListByWorkspace", + "description": "Lists the workspace vNet Peerings.", + "x-ms-examples": { + "List all vNet Peerings for the workspace": { + "$ref": "./examples/WorkspaceVirtualNetPeeringList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List succeeded. Returns the resulting resource objects in response body.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ErrorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorResponse": { + "title": "Error response.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/ErrorInfo" + } + }, + "required": [ + "error" + ] + }, + "VirtualNetworkPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "List of virtual network peerings on workspace." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of virtual network peering list results if there are any." + } + }, + "description": "Gets all virtual network peerings under a workspace." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "List of properties for vNet Peering" + }, + "name": { + "type": "string", + "description": "Name of the virtual network peering resource", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Resource ID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "type of the virtual network peering resource", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "description": "Peerings in a VirtualNetwork resource", + "x-ms-azure-resource": true + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "databricksVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the databricks virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "databricksAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the databricks virtual network address space." + }, + "remoteVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the remote virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the remote virtual network address space." + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "peeringState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/PeeringProvisioningState", + "description": "The provisioning state of the virtual network peering resource." + } + }, + "required": [ + "remoteVirtualNetwork" + ], + "description": "Properties of the virtual network peering." + }, + "PeeringProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PeeringProvisioningState", + "modelAsString": true + } + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + } + }, + "parameters": { + "WorkspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "PeeringNameParameter": { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace vNet peering.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/databricks/resource-manager/readme.md b/specification/databricks/resource-manager/readme.md index 4bc845677fb6..f889a8f8196f 100644 --- a/specification/databricks/resource-manager/readme.md +++ b/specification/databricks/resource-manager/readme.md @@ -10,6 +10,7 @@ This is the AutoRest configuration file for Databricks. ```yaml $(java) && $(multiapi) batch: + - tag: package-2024-09-01-preview - tag: package-2024-05-01 - tag: package-2023-09-15-preview - tag: package-2023-02-01 @@ -19,6 +20,19 @@ batch: - tag: package-2023-05-01 ``` +### Tag: package-2024-09-01-preview and java + +These settings apply only when `--tag=package-2024-09-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +```yaml $(tag) == 'package-2024-09-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databricks.v2024_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/databricks/mgmt-v2024_09_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2024-05-01 and java These settings apply only when `--tag=package-2024-05-01 --java` is specified on the command line. @@ -132,7 +146,7 @@ These are the global settings for the Databricks API. title: AzureDatabricksManagementClient description: The Microsoft Azure management APIs allow end users to operate on Azure Databricks Workspace / Access Connector resources. openapi-type: arm -tag: package-2024-05-01 +tag: package-2024-09-01-preview ``` ### Tag: package-2018-04-01 @@ -210,6 +224,18 @@ input-file: - Microsoft.Databricks/stable/2024-05-01/accessconnector.json ``` +### Tag: package-2024-09-01-preview + +These settings apply only when `--tag=package-2024-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-01-preview' +input-file: + - Microsoft.Databricks/preview/2024-09-01-preview/databricks.json + - Microsoft.Databricks/preview/2024-09-01-preview/vnetpeering.json + - Microsoft.Databricks/preview/2024-09-01-preview/accessconnector.json +``` + + --- # Suppressions diff --git a/specification/databricks/resource-manager/sdk-suppressions.yaml b/specification/databricks/resource-manager/sdk-suppressions.yaml index 9de72ee8dc3d..30ab9f17ce1f 100644 --- a/specification/databricks/resource-manager/sdk-suppressions.yaml +++ b/specification/databricks/resource-manager/sdk-suppressions.yaml @@ -2,4 +2,9 @@ suppressions: azure-sdk-for-js: - package: '@azure/arm-databricks' breaking-changes: - - Type of parameter enableNoPublicIp of interface WorkspaceCustomParameters is changed from WorkspaceCustomBooleanParameter to WorkspaceNoPublicIPBooleanParameter \ No newline at end of file + - Type of parameter enableNoPublicIp of interface WorkspaceCustomParameters is changed from WorkspaceCustomBooleanParameter to WorkspaceNoPublicIPBooleanParameter + azure-sdk-for-python: + - package: azure-mgmt-databricks + breaking-changes: + - The 'WorkspacesOperations' method 'begin_delete' had a 'positional_or_keyword' parameter 'force_deletion' inserted in the current version + - The 'WorkspacesOperations' method 'begin_delete' had a 'positional_or_keyword' parameter 'force_deletion' inserted in the current version From c0a15f4623eb11f745f890089f3d46d8a538524f Mon Sep 17 00:00:00 2001 From: Zao Wang <122930832+zaowang-ms@users.noreply.github.com> Date: Tue, 27 Aug 2024 14:19:05 -0700 Subject: [PATCH 15/30] Adding 2024-06-01-preview for nginx (#30043) * initial base * adding 2024-06-01 * initial base * adding 2024-06-01 * fixed go error --- .../examples/Certificates_CreateOrUpdate.json | 44 + .../examples/Certificates_Delete.json | 18 + .../examples/Certificates_Get.json | 31 + .../examples/Certificates_List.json | 49 + .../examples/Configurations_Analysis.json | 43 + .../Configurations_CreateOrUpdate.json | 65 + .../examples/Configurations_Delete.json | 18 + .../examples/Configurations_Get.json | 31 + .../examples/Configurations_List.json | 34 + .../examples/Deployments_Create.json | 165 ++ .../examples/Deployments_Delete.json | 17 + .../examples/Deployments_Get.json | 74 + .../examples/Deployments_Get_AutoScale.json | 61 + .../examples/Deployments_List.json | 74 + .../Deployments_ListByResourceGroup.json | 75 + .../examples/Deployments_Update.json | 136 ++ .../examples/Operations_List.json | 23 + .../preview/2024-06-01-preview/swagger.json | 1768 +++++++++++++++++ .../nginx/resource-manager/readme.md | 12 +- 19 files changed, 2737 insertions(+), 1 deletion(-) create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_CreateOrUpdate.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Delete.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Get.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Analysis.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_CreateOrUpdate.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Delete.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Get.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Create.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Delete.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get_AutoScale.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_ListByResourceGroup.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Update.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Operations_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/swagger.json diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_CreateOrUpdate.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_CreateOrUpdate.json new file mode 100644 index 000000000000..a1aa34891dd9 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "certificateName": "default", + "requestBody": { + "properties": { + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/default", + "name": "default", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/default", + "name": "default", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Accepted", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID" + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Delete.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Delete.json new file mode 100644 index 000000000000..5974fb1e6ee8 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "certificateName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Get.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Get.json new file mode 100644 index 000000000000..89f318ad0813 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "certificateName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/default", + "name": "default", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID", + "sha1Thumbprint": "1234567890ABCDEF1234567890ABCDEF12345678", + "keyVaultSecretVersion": "12345678ef9a12345678ef9a12345678", + "keyVaultSecretCreated": "2020-01-01T00:00:00Z", + "certificateError": { + "code": "CertificateNotYetValid", + "message": "The certificate is not yet valid. The certificate is not yet valid. NotBefore: '2020-01-01T00:00:00Z', NotAfter: '2020-01-01T00:00:00Z'" + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_List.json new file mode 100644 index 000000000000..325c6357096d --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Certificates_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/cert1", + "name": "cert1", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID", + "sha1Thumbprint": "1234567890ABCDEF1234567890ABCDEF12345678", + "keyVaultSecretVersion": "12345678ef9a12345678ef9a12345678", + "keyVaultSecretCreated": "2020-01-01T00:00:00Z", + "certificateError": { + "code": "CertificateNotYetValid", + "message": "The certificate is not yet valid. The certificate is not yet valid. NotBefore: '2020-01-01T00:00:00Z', NotAfter: '2020-01-01T00:00:00Z'" + } + } + }, + { + "id": "/subscritions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/cert2", + "name": "cert2", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey2.key", + "certificateVirtualPath": "/src/cert/somePath2.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID2", + "sha1Thumbprint": "1234567890ABCDEF1234567890ABCDEF12345678", + "keyVaultSecretVersion": "12345678ef9a12345678ef9a12345678", + "keyVaultSecretCreated": "2020-01-01T00:00:00Z", + "certificateError": null + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Analysis.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Analysis.json new file mode 100644 index 000000000000..4188470df6ab --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Analysis.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default", + "requestBody": { + "config": { + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + }, + "responses": { + "200": { + "body": { + "status": "FAILED", + "data": { + "errors": [ + { + "id": "config-analysis-error-1", + "directive": "worker_processes", + "description": "Directives outside the http context are not allowed", + "file": "/etc/nginx/nginx.conf", + "line": 2, + "message": "You are not allowed to set the worker_processes directive", + "rule": "nginx-azure-load-balancer-allowed-directives" + } + ] + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_CreateOrUpdate.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_CreateOrUpdate.json new file mode 100644 index 000000000000..f3800f826f87 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default", + "requestBody": { + "properties": { + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Succeeded", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Accepted", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Delete.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Delete.json new file mode 100644 index 000000000000..8a1a3f6f4970 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Get.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Get.json new file mode 100644 index 000000000000..90082d1ed097 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Succeeded", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_List.json new file mode 100644 index 000000000000..a5c55c136a00 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Configurations_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Succeeded", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Create.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Create.json new file mode 100644 index 000000000000..90afb3eb6000 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Create.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "requestBody": { + "name": "myDeployment", + "tags": { + "Environment": "Dev" + }, + "properties": { + "managedResourceGroup": "myManagedResourceGroup", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "userProfile": { + "preferredEmail": "example@example.email" + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + } + } + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + }, + "webApplicationFirewallStatus": { + "attackSignaturesPackage": { + "version": "2024.02.21", + "revisionDatetime": "2024-02-21T15:50:53Z" + }, + "botSignaturesPackage": { + "version": "2024.02.22", + "revisionDatetime": "2024-02-22T15:50:53Z" + }, + "threatCampaignsPackage": { + "version": "2024.02.23", + "revisionDatetime": "2024-02-23T15:50:53Z" + }, + "componentVersions": { + "wafEngineVersion": "10.624.0", + "wafNginxVersion": "4.815.0" + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Accepted", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Delete.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Delete.json new file mode 100644 index 000000000000..c20611a09bce --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get.json new file mode 100644 index 000000000000..8957c8d5e486 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "userProfile": { + "preferredEmail": "example@example.email" + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + }, + "webApplicationFirewallStatus": { + "attackSignaturesPackage": { + "version": "2024.02.21", + "revisionDatetime": "2024-02-21T15:50:53Z" + }, + "botSignaturesPackage": { + "version": "2024.02.22", + "revisionDatetime": "2024-02-22T15:50:53Z" + }, + "threatCampaignsPackage": { + "version": "2024.02.23", + "revisionDatetime": "2024-02-23T15:50:53Z" + }, + "componentVersions": { + "wafEngineVersion": "10.624.0", + "wafNginxVersion": "4.815.0" + } + } + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get_AutoScale.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get_AutoScale.json new file mode 100644 index 000000000000..63e512353196 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Get_AutoScale.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "userProfile": { + "preferredEmail": "example@example.email" + }, + "scalingProperties": { + "autoScaleSettings": { + "profiles": [ + { + "name": "ExampleProfile", + "capacity": { + "min": 10, + "max": 50 + } + } + ] + } + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_List.json new file mode 100644 index 000000000000..3fad2eac5f87 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_List.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + }, + "webApplicationFirewallStatus": { + "attackSignaturesPackage": { + "version": "2024.02.21", + "revisionDatetime": "2024-02-21T15:50:53Z" + }, + "botSignaturesPackage": { + "version": "2024.02.22", + "revisionDatetime": "2024-02-22T15:50:53Z" + }, + "threatCampaignsPackage": { + "version": "2024.02.23", + "revisionDatetime": "2024-02-23T15:50:53Z" + }, + "componentVersions": { + "wafEngineVersion": "10.624.0", + "wafNginxVersion": "4.815.0" + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_ListByResourceGroup.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_ListByResourceGroup.json new file mode 100644 index 000000000000..898d1f5d2de2 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_ListByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + }, + "webApplicationFirewallStatus": { + "attackSignaturesPackage": { + "version": "2024.02.21", + "revisionDatetime": "2024-02-21T15:50:53Z" + }, + "botSignaturesPackage": { + "version": "2024.02.22", + "revisionDatetime": "2024-02-22T15:50:53Z" + }, + "threatCampaignsPackage": { + "version": "2024.02.23", + "revisionDatetime": "2024-02-23T15:50:53Z" + }, + "componentVersions": { + "wafEngineVersion": "10.624.0", + "wafNginxVersion": "4.815.0" + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Update.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Update.json new file mode 100644 index 000000000000..a3a73b8f7f29 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Deployments_Update.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "requestBody": { + "tags": { + "Environment": "Dev" + }, + "properties": { + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "userProfile": { + "preferredEmail": "example@example.email" + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + }, + "webApplicationFirewallStatus": { + "attackSignaturesPackage": { + "version": "2024.02.21", + "revisionDatetime": "2024-02-21T15:50:53Z" + }, + "botSignaturesPackage": { + "version": "2024.02.22", + "revisionDatetime": "2024-02-22T15:50:53Z" + }, + "threatCampaignsPackage": { + "version": "2024.02.23", + "revisionDatetime": "2024-02-23T15:50:53Z" + }, + "componentVersions": { + "wafEngineVersion": "10.624.0", + "wafNginxVersion": "4.815.0" + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Accepted", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "scalingProperties": { + "capacity": 10 + }, + "autoUpgradeProfile": { + "upgradeChannel": "stable" + }, + "nginxAppProtect": { + "webApplicationFirewallSettings": { + "activationState": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Operations_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..9c10025050e8 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Nginx.NginxPlus/nginxDeployments/write", + "display": { + "provider": "Nginx.NginxPlus", + "resource": "deployments", + "operation": "write", + "description": "Write deployments resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/swagger.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/swagger.json new file mode 100644 index 000000000000..a8783433f020 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-06-01-preview/swagger.json @@ -0,0 +1,1768 @@ +{ + "swagger": "2.0", + "info": { + "title": "Nginx.NginxPlus", + "version": "2024-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates/{certificateName}": { + "get": { + "tags": [ + "NginxCertificate" + ], + "summary": "Get a certificate of given NGINX deployment", + "operationId": "Certificates_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "certificateName", + "description": "The name of certificate", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/Certificates_Get.json" + } + } + }, + "put": { + "tags": [ + "NginxCertificate" + ], + "summary": "Create or update the NGINX certificates for given NGINX deployment", + "operationId": "Certificates_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "certificateName", + "description": "The name of certificate", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The certificate", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Certificates_CreateOrUpdate": { + "$ref": "./examples/Certificates_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NginxCertificate" + ], + "summary": "Deletes a certificate from the NGINX deployment", + "operationId": "Certificates_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "certificateName", + "description": "The name of certificate", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Certificates_Delete": { + "$ref": "./examples/Certificates_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates": { + "get": { + "tags": [ + "NginxCertificate" + ], + "summary": "List all certificates of given NGINX deployment", + "operationId": "Certificates_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificateListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Certificates_List": { + "$ref": "./examples/Certificates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations": { + "get": { + "tags": [ + "NginxConfiguration" + ], + "summary": "List the NGINX configuration of given NGINX deployment.", + "operationId": "Configurations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfigurationListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Configurations_List": { + "$ref": "./examples/Configurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}": { + "get": { + "tags": [ + "NginxConfiguration" + ], + "summary": "Get the NGINX configuration of given NGINX deployment", + "operationId": "Configurations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "configurationName", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Configurations_Get": { + "$ref": "./examples/Configurations_Get.json" + } + } + }, + "put": { + "tags": [ + "NginxConfiguration" + ], + "summary": "Create or update the NGINX configuration for given NGINX deployment", + "operationId": "Configurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "configurationName", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The NGINX configuration", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Configurations_CreateOrUpdate": { + "$ref": "./examples/Configurations_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NginxConfiguration" + ], + "summary": "Reset the NGINX configuration of given NGINX deployment to default", + "operationId": "Configurations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "configurationName", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Configurations_Delete": { + "$ref": "./examples/Configurations_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}/analyze": { + "post": { + "tags": [ + "NginxConfigurationAnalysis" + ], + "summary": "Analyze an NGINX configuration without applying it to the NGINXaaS deployment", + "operationId": "Configurations_Analysis", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "configurationName", + "in": "path", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The NGINX configuration to analyze", + "schema": { + "$ref": "#/definitions/AnalysisCreate" + } + } + ], + "responses": { + "200": { + "description": "Analysis complete", + "schema": { + "$ref": "#/definitions/AnalysisResult" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Configurations_Analysis": { + "$ref": "./examples/Configurations_Analysis.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "Get the NGINX deployment", + "operationId": "Deployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Get": { + "$ref": "./examples/Deployments_Get.json" + }, + "Deployments_Get_AutoScale": { + "$ref": "./examples/Deployments_Get_AutoScale.json" + } + } + }, + "put": { + "tags": [ + "NginxDeployment" + ], + "summary": "Create or update the NGINX deployment", + "operationId": "Deployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Deployments_Create": { + "$ref": "./examples/Deployments_Create.json" + } + } + }, + "patch": { + "tags": [ + "NginxDeployment" + ], + "summary": "Update the NGINX deployment", + "operationId": "Deployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/NginxDeploymentUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Update": { + "$ref": "./examples/Deployments_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "NginxDeployment" + ], + "summary": "Delete the NGINX deployment resource", + "operationId": "Deployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_Delete": { + "$ref": "./examples/Deployments_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Nginx.NginxPlus/nginxDeployments": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "List the NGINX deployments resources", + "operationId": "Deployments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeploymentListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deployments_List": { + "$ref": "./examples/Deployments_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "List all NGINX deployments under the specified resource group.", + "operationId": "Deployments_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeploymentListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deployments_ListByResourceGroup": { + "$ref": "./examples/Deployments_ListByResourceGroup.json" + } + } + } + }, + "/providers/Nginx.NginxPlus/operations": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "List all operations provided by Nginx.NginxPlus for the 2024-06-01-preview api version.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "ScaleProfile": { + "type": "object", + "description": "The autoscale profile.", + "required": [ + "name", + "capacity" + ], + "x-ms-client-flatten": true, + "properties": { + "name": { + "type": "string", + "example": "ExampleProfile" + }, + "capacity": { + "type": "object", + "required": [ + "min", + "max" + ], + "description": "The capacity parameters of the profile.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of NCUs the deployment can be autoscaled to.", + "minimum": 0 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of NCUs the deployment can be autoscaled to.", + "minimum": 0 + } + } + } + } + }, + "AutoUpgradeProfile": { + "type": "object", + "description": "Autoupgrade settings of a deployment.", + "required": [ + "upgradeChannel" + ], + "properties": { + "upgradeChannel": { + "description": "Channel used for autoupgrade.", + "type": "string", + "example": "stable" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "NginxCertificateProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "keyVirtualPath": { + "type": "string" + }, + "certificateVirtualPath": { + "type": "string" + }, + "keyVaultSecretId": { + "type": "string" + }, + "sha1Thumbprint": { + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF12345678", + "readOnly": true + }, + "keyVaultSecretVersion": { + "type": "string", + "example": "12345678ef9a12345678ef9a12345678", + "readOnly": true + }, + "keyVaultSecretCreated": { + "type": "string", + "format": "date-time", + "example": "2022-01-01T00:00:00.000Z", + "readOnly": true + }, + "certificateError": { + "$ref": "#/definitions/NginxCertificateErrorResponseBody" + } + } + }, + "NginxCertificateErrorResponseBody": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "NginxCertificate": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/NginxCertificateProperties" + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "NginxCertificateListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "NginxConfigurationFile": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "virtualPath": { + "type": "string" + } + } + }, + "NginxConfigurationPackage": { + "type": "object", + "properties": { + "data": { + "type": "string" + }, + "protectedFiles": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "NginxConfigurationProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "protectedFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "package": { + "$ref": "#/definitions/NginxConfigurationPackage" + }, + "rootFile": { + "type": "string" + } + } + }, + "NginxConfiguration": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/NginxConfigurationProperties" + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "NginxConfigurationListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + } + } + }, + "IdentityType": { + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IdentityType" + } + }, + "UserIdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true + }, + "clientId": { + "type": "string", + "readOnly": true + } + } + }, + "ResourceSku": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU.", + "type": "string" + } + } + }, + "IdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true + }, + "tenantId": { + "type": "string", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/IdentityType" + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + } + }, + "NginxPrivateIPAllocationMethod": { + "enum": [ + "Static", + "Dynamic" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "NginxPrivateIPAllocationMethod" + } + }, + "NginxPrivateIPAddress": { + "type": "object", + "properties": { + "privateIPAddress": { + "type": "string" + }, + "privateIPAllocationMethod": { + "$ref": "#/definitions/NginxPrivateIPAllocationMethod" + }, + "subnetId": { + "type": "string" + } + } + }, + "NginxPublicIPAddress": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "NginxFrontendIPConfiguration": { + "type": "object", + "properties": { + "publicIPAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxPublicIPAddress" + }, + "x-ms-identifiers": [] + }, + "privateIPAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxPrivateIPAddress" + }, + "x-ms-identifiers": [] + } + } + }, + "NginxNetworkInterfaceConfiguration": { + "type": "object", + "properties": { + "subnetId": { + "type": "string" + } + } + }, + "NginxNetworkProfile": { + "type": "object", + "properties": { + "frontEndIPConfiguration": { + "$ref": "#/definitions/NginxFrontendIPConfiguration" + }, + "networkInterfaceConfiguration": { + "$ref": "#/definitions/NginxNetworkInterfaceConfiguration" + } + } + }, + "NginxStorageAccount": { + "type": "object", + "properties": { + "accountName": { + "type": "string" + }, + "containerName": { + "type": "string" + } + } + }, + "NginxLogging": { + "type": "object", + "properties": { + "storageAccount": { + "$ref": "#/definitions/NginxStorageAccount" + } + } + }, + "NginxDeploymentScalingProperties": { + "type": "object", + "description": "Information on how the deployment will be scaled.", + "properties": { + "capacity": { + "format": "int32", + "type": "integer", + "example": 20 + }, + "autoScaleSettings": { + "type": "object", + "required": [ + "profiles" + ], + "description": "The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty.", + "x-ms-client-flatten": true, + "properties": { + "profiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScaleProfile" + }, + "x-ms-identifiers": [] + } + } + } + } + }, + "NginxDeploymentUserProfile": { + "type": "object", + "properties": { + "preferredEmail": { + "type": "string", + "format": "email", + "pattern": "^$|^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$", + "description": "The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address.", + "example": [ + "", + "john.doe@example.com", + "tom@example.com" + ] + } + } + }, + "NginxDeploymentProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "nginxVersion": { + "type": "string", + "readOnly": true + }, + "managedResourceGroup": { + "type": "string", + "description": "The managed resource group to deploy VNet injection related network resources." + }, + "networkProfile": { + "$ref": "#/definitions/NginxNetworkProfile" + }, + "ipAddress": { + "type": "string", + "description": "The IP address of the deployment.", + "readOnly": true + }, + "enableDiagnosticsSupport": { + "type": "boolean" + }, + "logging": { + "$ref": "#/definitions/NginxLogging" + }, + "scalingProperties": { + "$ref": "#/definitions/NginxDeploymentScalingProperties" + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/AutoUpgradeProfile" + }, + "userProfile": { + "$ref": "#/definitions/NginxDeploymentUserProfile" + }, + "nginxAppProtect": { + "type": "object", + "description": "Settings for NGINX App Protect (NAP)", + "required": [ + "webApplicationFirewallSettings" + ], + "properties": { + "webApplicationFirewallSettings": { + "$ref": "#/definitions/WebApplicationFirewallSettings" + }, + "webApplicationFirewallStatus": { + "$ref": "#/definitions/WebApplicationFirewallStatus", + "readOnly": true + } + } + } + } + }, + "NginxDeployment": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/IdentityProperties" + }, + "properties": { + "$ref": "#/definitions/NginxDeploymentProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "NginxDeploymentUpdateProperties": { + "type": "object", + "properties": { + "enableDiagnosticsSupport": { + "type": "boolean" + }, + "logging": { + "$ref": "#/definitions/NginxLogging" + }, + "scalingProperties": { + "$ref": "#/definitions/NginxDeploymentScalingProperties" + }, + "userProfile": { + "$ref": "#/definitions/NginxDeploymentUserProfile" + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/AutoUpgradeProfile" + }, + "nginxAppProtect": { + "type": "object", + "description": "Update settings for NGINX App Protect (NAP)", + "properties": { + "webApplicationFirewallSettings": { + "$ref": "#/definitions/WebApplicationFirewallSettings" + } + } + } + } + }, + "NginxDeploymentUpdateParameters": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "location": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/NginxDeploymentUpdateProperties" + } + } + }, + "NginxDeploymentListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Nginx.NginxPlus", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'deployments'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write deployments'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Nginx.NginxPlus REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list Nginx.NginxPlus operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Nginx.NginxPlus provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "AnalysisCreate": { + "type": "object", + "description": "The request body for creating an analysis for an NGINX configuration.", + "properties": { + "config": { + "type": "object", + "properties": { + "rootFile": { + "type": "string", + "description": "The root file of the NGINX config file(s). It must match one of the files' filepath." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "protectedFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "package": { + "$ref": "#/definitions/NginxConfigurationPackage" + } + } + } + }, + "required": [ + "config" + ] + }, + "AnalysisResult": { + "type": "object", + "description": "The response body for an analysis request. Contains the status of the analysis and any errors.", + "required": [ + "status" + ], + "properties": { + "status": { + "type": "string", + "description": "The status of the analysis." + }, + "data": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalysisDiagnostic" + } + } + } + } + } + }, + "AnalysisDiagnostic": { + "type": "object", + "description": "An error object found during the analysis of an NGINX configuration.", + "required": [ + "directive", + "description", + "file", + "line", + "message", + "rule" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the error" + }, + "directive": { + "type": "string", + "example": "worker_processes" + }, + "description": { + "type": "string", + "example": "Directives outside the http context are not allowed" + }, + "file": { + "type": "string", + "description": "the filepath of the most relevant config file", + "example": "nginx.conf" + }, + "line": { + "type": "number", + "example": 2 + }, + "message": { + "type": "string", + "example": "You are not allowed to set the worker_processes directive" + }, + "rule": { + "type": "string", + "example": "nginx-azure-load-balancer-allowed-directives" + } + } + }, + "WebApplicationFirewallSettings": { + "type": "object", + "description": "Settings for the NGINX App Protect Web Application Firewall (WAF)", + "properties": { + "activationState": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it.", + "x-ms-enum": { + "modelAsString": true, + "name": "activationState" + } + } + } + }, + "WebApplicationFirewallStatus": { + "type": "object", + "description": "The status of the NGINX App Protect Web Application Firewall", + "properties": { + "attackSignaturesPackage": { + "$ref": "#/definitions/WebApplicationFirewallPackage", + "readOnly": true, + "description": "Package containing attack signatures for the NGINX App Protect Web Application Firewall (WAF)." + }, + "botSignaturesPackage": { + "$ref": "#/definitions/WebApplicationFirewallPackage", + "readOnly": true, + "description": "Package containing bot signatures for the NGINX App Protect Web Application Firewall (WAF)." + }, + "threatCampaignsPackage": { + "$ref": "#/definitions/WebApplicationFirewallPackage", + "readOnly": true, + "description": "Package containing threat campaigns for the NGINX App Protect Web Application Firewall (WAF)." + }, + "componentVersions": { + "$ref": "#/definitions/WebApplicationFirewallComponentVersions", + "readOnly": true, + "description": "Versions of the NGINX App Protect Web Application Firewall (WAF) components." + } + } + }, + "WebApplicationFirewallPackage": { + "type": "object", + "description": "NGINX App Protect Web Application Firewall (WAF) Package. Contains the version and revision date of the package.", + "required": [ + "version", + "revisionDatetime" + ], + "properties": { + "version": { + "type": "string", + "example": "2.02", + "description": "The version of the NGINX App Protect Web Application Firewall (WAF) package." + }, + "revisionDatetime": { + "type": "string", + "example": "2024-02-21T15:50:53Z", + "format": "date-time", + "description": "The date and time of the package revision." + } + } + }, + "WebApplicationFirewallComponentVersions": { + "type": "object", + "readOnly": true, + "required": [ + "wafEngineVersion", + "wafNginxVersion" + ], + "description": "Versions of the NGINX App Protect Web Application Firewall (WAF) components.", + "properties": { + "wafEngineVersion": { + "type": "string", + "example": "10.624.0", + "description": "The version of the NGINX App Protect Web Application Firewall (WAF) engine." + }, + "wafNginxVersion": { + "type": "string", + "example": "4.815.0", + "description": "The version of the NGINX App Protect Web Application Firewall (WAF) module for NGINX." + } + } + } + }, + "parameters": { + "DeploymentNameParameter": { + "in": "path", + "name": "deploymentName", + "description": "The name of targeted NGINX deployment", + "pattern": "^([a-z0-9A-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]|[a-z0-9A-Z])$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/nginx/resource-manager/readme.md b/specification/nginx/resource-manager/readme.md index fae576143fd1..ea7859659d3e 100644 --- a/specification/nginx/resource-manager/readme.md +++ b/specification/nginx/resource-manager/readme.md @@ -28,9 +28,19 @@ These are the global settings for the Nginx API. title: NginxManagementClient openapi-type: arm openapi-subtype: rpaas -tag: package-2024-01-01-preview +tag: package-2024-06-01-preview ``` +### Tag: package-2024-06-01-preview + +These settings apply only when `--tag=package-2024-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06-01-preview' +input-file: +- NGINX.NGINXPLUS/preview/2024-06-01-preview/swagger.json +``` + + ### Tag: package-2024-01-01-preview These settings apply only when `--tag=package-2024-01-01-preview` is specified on the command line. From 4bc9b37173bd5fe0ed19f21edfb8a195e89caaf6 Mon Sep 17 00:00:00 2001 From: Wenjun Gao Date: Tue, 27 Aug 2024 19:55:39 -0700 Subject: [PATCH 16/30] Remove outdated constrains from description (#30344) Co-authored-by: wenjungao --- .../aks/preview/2024-04-02-preview/managedClusters.json | 2 +- .../aks/preview/2024-05-02-preview/managedClusters.json | 2 +- .../aks/preview/2024-06-02-preview/managedClusters.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json index 89d36d4fa313..0116071d94bd 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json @@ -4183,7 +4183,7 @@ "$ref": "#/definitions/ManualScaleProfile" }, "x-ms-identifiers": [], - "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size. Currently, at most one ManualScaleProfile is allowed." + "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size." }, "autoscale": { "type": "array", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/managedClusters.json index 97d66937b363..23edd277f03b 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/managedClusters.json @@ -4141,7 +4141,7 @@ "$ref": "#/definitions/ManualScaleProfile" }, "x-ms-identifiers": [], - "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size. Currently, at most one ManualScaleProfile is allowed." + "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size." }, "autoscale": { "type": "array", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-06-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-06-02-preview/managedClusters.json index 6c9eac9e57f6..cf26368100a3 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-06-02-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-06-02-preview/managedClusters.json @@ -4141,7 +4141,7 @@ "$ref": "#/definitions/ManualScaleProfile" }, "x-ms-identifiers": [], - "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size. Currently, at most one ManualScaleProfile is allowed." + "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size." }, "autoscale": { "type": "array", From a3913f4b26467aed413cdc907116e99894f08994 Mon Sep 17 00:00:00 2001 From: Dhruvil Shah Date: Tue, 27 Aug 2024 23:42:35 -0700 Subject: [PATCH 17/30] Add new Swagger definition to comply with Azure-CLI SDK requirements (#30207) * Add new Swagger definition to comply with Azure-CLI SDK requirements * Remove Version Upgrade --------- Co-authored-by: Dhruvil Shah --- .../azurefleet/AzureFleet.Management/fleet.tsp | 4 ++-- .../preview/2023-11-01-preview/azurefleet.json | 10 +++++----- .../preview/2024-05-01-preview/azurefleet.json | 10 +++++----- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index ee8abc852867..2ea667384c57 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -17,7 +17,7 @@ model Fleet is TrackedResource { @doc("The name of the Compute Fleet") @key("fleetName") @segment("fleets") - @pattern("^[^_\\W][\\w-._]{0,79}(?, ...ResourceNameParameter< Fleet, - NamePattern = "^[^_\\W][\\w-._]{0,79}(?, ): ArmResponse | ErrorResponse; } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json index 1e5cfc6b2e3b..e92b60119542 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json @@ -195,7 +195,7 @@ "description": "The name of the Compute Fleet", "required": true, "type": "string", - "pattern": "^[^_\\W][\\w-._]{0,79}(? Date: Wed, 28 Aug 2024 11:54:53 +0300 Subject: [PATCH 18/30] Deprecate AAC and ANH (#30163) * deprecate aac and anh * Update adaptiveNetworkHardenings.json * Update applicationWhitelistings.json * Update adaptiveNetworkHardenings.json * Update applicationWhitelistings.json * add deprecation notice to description * fix conflicts * surprese files * merge * another tey * try again * try again * try again * try again * try again * try again * try again * remove deprecated files * return files * ck * ck * ck * ck * ck * ck * ck * ck * ck * Update sdk-suppressions.yaml --------- Co-authored-by: Ron Friedner Co-authored-by: Elia Grady Co-authored-by: Yuchao Yan --- .../adaptiveNetworkHardenings.json | 412 ------- .../applicationWhitelistings.json | 606 ---------- ...AdaptiveNetworkHardeningRules_example.json | 50 - .../GetAdaptiveNetworkHardening_example.json | 62 - ...urceAdaptiveNetworkHardenings_example.json | 65 -- ...eleteApplicationWhitelistings_example.json | 13 - ...ApplicationWhitelistingsGroup_example.json | 132 --- ...tionWhitelistingsSubscription_example.json | 1028 ----------------- .../PutApplicationWhitelistings_example.json | 232 ---- .../2020-01-01/adaptiveNetworkHardenings.json | 416 ------- .../2020-01-01/applicationWhitelistings.json | 576 --------- ...AdaptiveNetworkHardeningRules_example.json | 50 - .../GetAdaptiveNetworkHardening_example.json | 62 - ...urceAdaptiveNetworkHardenings_example.json | 65 -- ...teAdaptiveApplicationControls_example.json | 13 - ...ptiveApplicationControlsGroup_example.json | 132 --- ...plicationControlsSubscription_example.json | 1028 ----------------- ...utAdaptiveApplicationControls_example.json | 229 ---- .../security/resource-manager/readme.md | 14 - .../resource-manager/sdk-suppressions.yaml | 2 + 20 files changed, 2 insertions(+), 5185 deletions(-) delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/DeleteApplicationWhitelistings_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsGroup_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsSubscription_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/PutApplicationWhitelistings_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/DeleteAdaptiveApplicationControls_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsGroup_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsSubscription_example.json delete mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/PutAdaptiveApplicationControls_example.json diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json deleted file mode 100644 index b094625eac43..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json +++ /dev/null @@ -1,412 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Defender for Cloud", - "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider", - "version": "2015-06-01-preview" - }, - "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/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings": { - "get": { - "x-ms-examples": { - "List Adaptive Network Hardenings resources of an extended resource": { - "$ref": "./examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json" - } - }, - "description": "Gets a list of Adaptive Network Hardenings resources in scope of an extended resource.", - "tags": [ - "AdaptiveNetworkHardenings" - ], - "operationId": "AdaptiveNetworkHardenings_ListByExtendedResource", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardeningsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}": { - "get": { - "x-ms-examples": { - "Get a single Adaptive Network Hardening resource": { - "$ref": "./examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json" - } - }, - "tags": [ - "AdaptiveNetworkHardenings" - ], - "description": "Gets a single Adaptive Network Hardening resource", - "operationId": "AdaptiveNetworkHardenings_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardening" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}/{adaptiveNetworkHardeningEnforceAction}": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Enforces the given rules on the NSG(s) listed in the request": { - "$ref": "./examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json" - } - }, - "tags": [ - "AdaptiveNetworkHardenings" - ], - "description": "Enforces the given rules on the NSG(s) listed in the request", - "operationId": "AdaptiveNetworkHardenings_Enforce", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceAction" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceRequest" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "PortNumber": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "Rule": { - "description": "Describes remote addresses that is recommended to communicate with the Azure resource on some (Protocol, Port, Direction). All other remote addresses are recommended to be blocked", - "properties": { - "name": { - "description": "The name of the rule", - "type": "string" - }, - "direction": { - "description": "The rule's direction", - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ], - "x-ms-enum": { - "name": "direction", - "modelAsString": true - } - }, - "destinationPort": { - "description": "The rule's destination port", - "$ref": "#/definitions/PortNumber" - }, - "protocols": { - "description": "The rule's transport protocols", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TCP", - "UDP" - ], - "x-ms-enum": { - "name": "transportProtocol", - "modelAsString": true - } - } - }, - "ipAddresses": { - "description": "The remote IP addresses that should be able to communicate with the Azure resource on the rule's destination port and protocol", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "EffectiveNetworkSecurityGroups": { - "description": "Describes the Network Security Groups effective on a network interface", - "properties": { - "networkInterface": { - "description": "The Azure resource ID of the network interface", - "type": "string" - }, - "networkSecurityGroups": { - "description": "The Network Security Groups effective on the network interface", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "AdaptiveNetworkHardeningProperties": { - "description": "Adaptive Network Hardening resource properties", - "properties": { - "rules": { - "description": "The security rules which are recommended to be effective on the VM", - "type": "array", - "items": { - "$ref": "#/definitions/Rule" - } - }, - "rulesCalculationTime": { - "type": "string", - "format": "date-time", - "description": "The UTC time on which the rules were calculated" - }, - "effectiveNetworkSecurityGroups": { - "description": "The Network Security Groups effective on the network interfaces of the protected resource", - "type": "array", - "items": { - "$ref": "#/definitions/EffectiveNetworkSecurityGroups" - } - } - } - }, - "AdaptiveNetworkHardening": { - "description": "The resource whose properties describes the Adaptive Network Hardening settings for some Azure resource", - "properties": { - "properties": { - "description": "Properties of the Adaptive Network Hardening resource", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AdaptiveNetworkHardeningProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "AdaptiveNetworkHardeningsList": { - "description": "Response for ListAdaptiveNetworkHardenings API service call", - "properties": { - "value": { - "description": "A list of Adaptive Network Hardenings resources", - "type": "array", - "items": { - "$ref": "#/definitions/AdaptiveNetworkHardening" - } - }, - "nextLink": { - "description": "The URL to get the next set of results", - "type": "string" - } - } - }, - "AdaptiveNetworkHardeningEnforceRequest": { - "type": "object", - "properties": { - "rules": { - "type": "array", - "description": "The rules to enforce", - "items": { - "$ref": "#/definitions/Rule" - } - }, - "networkSecurityGroups": { - "type": "array", - "description": "The Azure resource IDs of the effective network security groups that will be updated with the created security rules from the Adaptive Network Hardening rules", - "items": { - "type": "string" - } - } - }, - "required": [ - "rules", - "networkSecurityGroups" - ] - } - }, - "parameters": { - "AdaptiveNetworkHardeningResourceName": { - "name": "adaptiveNetworkHardeningResourceName", - "in": "path", - "description": "The name of the Adaptive Network Hardening resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AdaptiveNetworkHardeningEnforceAction": { - "name": "adaptiveNetworkHardeningEnforceAction", - "type": "string", - "in": "path", - "required": true, - "description": "Enforces the given rules on the NSG(s) listed in the request", - "enum": [ - "enforce" - ], - "x-ms-parameter-location": "method" - }, - "AdaptiveNetworkHardeningEnforceRequest": { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardeningEnforceRequest" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json deleted file mode 100644 index 3d9fb3fcf78c..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json +++ /dev/null @@ -1,606 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Defender for Cloud", - "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider", - "version": "2015-06-01-preview" - }, - "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}/providers/Microsoft.Security/applicationWhitelistings": { - "get": { - "description": "Gets a list of application control VM/server groups for the subscription.", - "operationId": "AdaptiveApplicationControls_List", - "x-ms-examples": { - "Gets a list of application control VM/server groups for the subscription": { - "$ref": "./examples/ApplicationWhitelistings/GetApplicationWhitelistingsSubscription_example.json" - } - }, - "tags": [ - "applicationWhitelistings" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IncludePathRecommendations" - }, - { - "$ref": "#/parameters/Summary" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AppWhitelistingGroups" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/applicationWhitelistings/{groupName}": { - "get": { - "description": "Gets an application control VM/server group.", - "operationId": "AdaptiveApplicationControls_Get", - "x-ms-examples": { - "Gets a configured application control VM/server group": { - "$ref": "./examples/ApplicationWhitelistings/GetApplicationWhitelistingsGroup_example.json" - } - }, - "tags": [ - "applicationWhitelistings" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/GroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AppWhitelistingGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "applicationWhitelistings" - ], - "x-ms-examples": { - "Update an application control VM/server group by adding a new file": { - "$ref": "./examples/ApplicationWhitelistings/PutApplicationWhitelistings_example.json" - } - }, - "description": "Update an application control VM/server group", - "operationId": "AdaptiveApplicationControls_Put", - "consumes": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/GroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/AppWhitelistingGroupDataPutDataBody" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AppWhitelistingGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an application control VM/server group": { - "$ref": "./examples/ApplicationWhitelistings/DeleteApplicationWhitelistings_example.json" - } - }, - "tags": [ - "applicationWhitelistings" - ], - "description": "Delete an application control VM/server group", - "operationId": "AdaptiveApplicationControls_Delete", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/GroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK - The response indicates that the delete operation completed successfully" - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "No Content. The response indicates the resource is already deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "AppWhitelistingGroups": { - "type": "object", - "description": "Represents a list of VM/server groups and set of rules that are Recommended by Microsoft Defender for Cloud to be allowed", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AppWhitelistingGroup" - } - } - } - }, - "AppWhitelistingGroup": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AppWhitelistingGroupData" - } - }, - "required": [ - "properties" - ], - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - }, - { - "$ref": "../../../common/v1/types.json#/definitions/Location" - } - ] - }, - "AppWhitelistingGroupData": { - "type": "object", - "description": "Represents a VM/server group and set of rules that are Recommended by Microsoft Defender for Cloud to be allowed", - "properties": { - "enforcementMode": { - "$ref": "#/definitions/EnforcementMode" - }, - "protectionMode": { - "$ref": "#/definitions/ProtectionMode" - }, - "configurationStatus": { - "$ref": "#/definitions/ConfigurationStatus" - }, - "recommendationStatus": { - "$ref": "#/definitions/RecommendationStatus" - }, - "issues": { - "$ref": "#/definitions/AppWhitelistingIssuesSummaries" - }, - "sourceSystem": { - "$ref": "#/definitions/SourceSystem" - }, - "vmRecommendations": { - "$ref": "#/definitions/VmRecommendations" - }, - "pathRecommendations": { - "$ref": "#/definitions/PathRecommendations" - } - } - }, - "AppWhitelistingPutGroupData": { - "type": "object", - "description": "The altered data of the recommended VM/server group policy", - "properties": { - "enforcementMode": { - "description": "The enforcement mode of the group. Can also be defined per collection type by using ProtectionMode", - "$ref": "#/definitions/EnforcementMode" - }, - "protectionMode": { - "description": "The protection mode of the group per collection type. Can also be defined for all collection types by using EnforcementMode", - "$ref": "#/definitions/ProtectionMode" - }, - "vmRecommendations": { - "$ref": "#/definitions/VmRecommendations" - }, - "pathRecommendations": { - "$ref": "#/definitions/PathRecommendations" - } - } - }, - "ConfigurationStatus": { - "type": "string", - "description": "The configuration status of the VM/server group or machine or rule on the machine", - "enum": [ - "Configured", - "NotConfigured", - "InProgress", - "Failed", - "NoStatus" - ] - }, - "EnforcementMode": { - "type": "string", - "description": "The application control policy enforcement/protection mode of the VM/server group", - "enum": [ - "Audit", - "Enforce", - "None" - ] - }, - "EnforcementSupport": { - "type": "string", - "description": "The VM/server supportability of Enforce feature", - "enum": [ - "Supported", - "NotSupported", - "Unknown" - ] - }, - "ProtectionMode": { - "type": "object", - "description": "The protection mode of the collection/file types. Exe/Msi/Script are used for Windows, Executable is used for Linux.", - "properties": { - "exe": { - "$ref": "#/definitions/EnforcementMode" - }, - "msi": { - "$ref": "#/definitions/EnforcementMode" - }, - "script": { - "$ref": "#/definitions/EnforcementMode" - }, - "executable": { - "$ref": "#/definitions/EnforcementMode" - } - } - }, - "RecommendationStatus": { - "type": "string", - "description": "The recommendation status of the VM/server group or VM/server", - "enum": [ - "Recommended", - "NotRecommended", - "NotAvailable", - "NoStatus" - ] - }, - "RecommendationAction": { - "type": "string", - "description": "The recommendation action of the VM/server or rule", - "enum": [ - "Recommended", - "Add", - "Remove" - ] - }, - "RecommendationType": { - "type": "string", - "description": "The type of the rule to be allowed", - "enum": [ - "File", - "FileHash", - "PublisherSignature", - "ProductSignature", - "BinarySignature", - "VersionAndAboveSignature" - ] - }, - "AppWhitelistingIssue": { - "type": "string", - "description": "An alert that VMs/servers within a group can have", - "enum": [ - "ViolationsAudited", - "ViolationsBlocked", - "MsiAndScriptViolationsAudited", - "MsiAndScriptViolationsBlocked", - "ExecutableViolationsAudited", - "RulesViolatedManually" - ] - }, - "FileType": { - "type": "string", - "description": "The type of the file (for Linux files - Executable is used)", - "enum": [ - "Exe", - "Dll", - "Msi", - "Script", - "Executable", - "Unknown" - ] - }, - "SourceSystem": { - "type": "string", - "description": "The source type of the VM/server group", - "enum": [ - "Azure_AppLocker", - "Azure_AuditD", - "NonAzure_AppLocker", - "NonAzure_AuditD", - "None" - ] - }, - "AppWhitelistingIssueSummary": { - "type": "object", - "description": "Represents a summary of the alerts of the VM/server group", - "properties": { - "issue": { - "$ref": "#/definitions/AppWhitelistingIssue" - }, - "numberOfVms": { - "type": "number", - "description": "The number of machines in the VM/server group that have this alert" - } - } - }, - "AppWhitelistingIssuesSummaries": { - "type": "array", - "items": { - "$ref": "#/definitions/AppWhitelistingIssueSummary" - } - }, - "VmRecommendations": { - "type": "array", - "items": { - "$ref": "#/definitions/VmRecommendation" - } - }, - "VmRecommendation": { - "type": "object", - "description": "Represents a machine that is part of a VM/server group", - "properties": { - "configurationStatus": { - "$ref": "#/definitions/ConfigurationStatus" - }, - "recommendationAction": { - "$ref": "#/definitions/RecommendationAction" - }, - "resourceId": { - "$ref": "#/definitions/VmResourceId" - }, - "enforcementSupport": { - "$ref": "#/definitions/EnforcementSupport" - } - } - }, - "PublisherInfo": { - "type": "object", - "description": "Represents the publisher information of a process/rule", - "properties": { - "publisherName": { - "type": "string", - "description": "The Subject field of the x.509 certificate used to sign the code, using the following fields - O = Organization, L = Locality, S = State or Province, and C = Country", - "example": "O=GOOGLE INC, L=MOUNTAIN VIEW, S=CALIFORNIA, C=US" - }, - "productName": { - "type": "string", - "description": "The product name taken from the file's version resource", - "example": "GOOGLE CHROME" - }, - "binaryName": { - "type": "string", - "description": "The \"OriginalName\" field taken from the file's version resource", - "example": "CHROME.EXE" - }, - "version": { - "type": "string", - "description": "The binary file version taken from the file's version resource", - "example": "66.0.3359.139" - } - } - }, - "UserRecommendation": { - "type": "object", - "description": "Represents a user that is recommended to be allowed for a certain rule", - "properties": { - "username": { - "type": "string", - "description": "Represents a user that is recommended to be allowed for a certain rule", - "example": "LOCAL SYSTEM" - }, - "recommendationAction": { - "$ref": "#/definitions/RecommendationAction" - } - } - }, - "PathRecommendations": { - "type": "array", - "items": { - "$ref": "#/definitions/PathRecommendation" - } - }, - "PathRecommendation": { - "type": "object", - "description": "Represents a path that is recommended to be allowed and its properties", - "properties": { - "path": { - "type": "string", - "description": "The full path to the application to allow", - "example": "C:\\Windows\\System32\\calc.exe" - }, - "action": { - "$ref": "#/definitions/RecommendationAction" - }, - "type": { - "$ref": "#/definitions/RecommendationType" - }, - "publisherInfo": { - "$ref": "#/definitions/PublisherInfo" - }, - "common": { - "type": "boolean", - "description": "Whether the path is commonly run on the machine" - }, - "userSids": { - "type": "array", - "items": { - "type": "string", - "description": "A security identifier", - "example": "S-1-5-18" - } - }, - "usernames": { - "type": "array", - "items": { - "$ref": "#/definitions/UserRecommendation" - } - }, - "fileType": { - "$ref": "#/definitions/FileType" - }, - "configurationStatus": { - "$ref": "#/definitions/ConfigurationStatus" - } - } - }, - "GroupResourceId": { - "type": "string", - "description": "The azure resource id of the application control VM/server group", - "example": "/subscriptions/12345678-1234-1234-1234-123456789123/providers/Microsoft.Security/applicationWhitelistings/GROUP1" - }, - "VmResourceId": { - "type": "string", - "description": "The full azure resource id of the machine", - "example": "/subscriptions/12345678-1234-1234-1234-123456789123/resourcegroups/group/providers/microsoft.compute/virtualmachines/vm" - }, - "AppWhitelistingResourceType": { - "type": "string", - "description": "The resource type of the application control resources", - "example": "Microsoft.Security/applicationWhitelistings" - } - }, - "parameters": { - "GroupName": { - "name": "groupName", - "in": "path", - "description": "Name of an application control VM/server group", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "IncludePathRecommendations": { - "name": "includePathRecommendations", - "in": "query", - "description": "Include the policy rules", - "type": "boolean", - "required": false, - "enum": [ - false, - true - ], - "x-ms-parameter-location": "method" - }, - "Summary": { - "name": "summary", - "in": "query", - "description": "Return output in a summarized form", - "type": "boolean", - "required": false, - "enum": [ - false, - true - ], - "x-ms-parameter-location": "method" - }, - "AppWhitelistingGroupDataPutDataBody": { - "in": "body", - "name": "body", - "description": "The updated VM/server group data", - "required": true, - "schema": { - "$ref": "#/definitions/AppWhitelistingPutGroupData" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json deleted file mode 100644 index 2f1af8243ff2..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1", - "adaptiveNetworkHardeningResourceName": "default", - "adaptiveNetworkHardeningEnforceAction": "enforce", - "body": { - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg2" - ] - } - }, - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json deleted file mode 100644 index 1d5bbfff58b3..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1", - "adaptiveNetworkHardeningResourceName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", - "name": "default", - "type": "Microsoft.Security/adaptiveNetworkHardenings", - "properties": { - "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "effectiveNetworkSecurityGroups": [ - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" - ] - }, - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg2/providers/Microsoft.Network/networkInterfaces/nic2", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nicNsg" - ] - } - ] - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json deleted file mode 100644 index 99ecba355acf..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", - "name": "default", - "type": "Microsoft.Security/adaptiveNetworkHardenings", - "properties": { - "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "effectiveNetworkSecurityGroups": [ - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" - ] - }, - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic2", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg2" - ] - } - ] - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/DeleteApplicationWhitelistings_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/DeleteApplicationWhitelistings_example.json deleted file mode 100644 index becfa217a797..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/DeleteApplicationWhitelistings_example.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154baf", - "groupName": "GROUP1", - "ascLocation": "centralus" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsGroup_example.json deleted file mode 100644 index 835920be358e..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsGroup_example.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154baf", - "ascLocation": "centralus", - "groupName": "ERELGROUP1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/ERELGROUP1", - "name": "ERELGROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "Audit", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/matanvs/providers/microsoft.compute/virtualmachines/matanvs19", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\PACKAGES_201973_7415\\COLLECTGUESTLOGS.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "C:\\directory\\file.exe", - "type": "File", - "common": true, - "action": "Add", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsSubscription_example.json deleted file mode 100644 index 4d617b11c54b..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/GetApplicationWhitelistingsSubscription_example.json +++ /dev/null @@ -1,1028 +0,0 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154baf", - "includePathRecommendations": true, - "summary": false - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/AMIT-VA", - "name": "AMIT-VA", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "Audit", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/erelh-dsc/providers/microsoft.compute/virtualmachines/erelh-14011", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/amit-va/providers/microsoft.compute/virtualmachines/ream-test", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/v-arrikl-scheduledapps/providers/microsoft.compute/virtualmachines/v-arrikl-14060", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "C:\\Windows\\SoftwareDistribution\\Download\\Install\\Windows-KB890830-x64-V5.53-delta.exe", - "type": "File", - "common": true, - "action": "Remove", - "usernames": [ - { - "username": "LOCAL SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-5-18" - ], - "fileType": "Exe", - "configurationStatus": "NoStatus" - }, - { - "path": "C:\\WindowsAzure\\GuestAgent_2.7.1198.822\\CollectGuestLogs.exe", - "type": "File", - "common": true, - "action": "Remove", - "usernames": [ - { - "username": "LOCAL SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-5-18" - ], - "fileType": "Exe", - "configurationStatus": "NoStatus" - }, - { - "path": "C:\\Windows\\System32\\wbem\\WmiPrvSE.exe", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-5-18", - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/ERELGROUP1", - "name": "ERELGROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended", - "enforcementSupport": "NotSupported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/GROUP1", - "name": "GROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/talk-va/providers/microsoft.compute/virtualmachines/tal-win-vm", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/talk-va/providers/microsoft.compute/virtualmachines/tal-win-vm-jit", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/myresourcegroup/providers/microsoft.compute/virtualmachines/myvmweb", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/v-arrikl-scheduledapps/providers/microsoft.compute/virtualmachines/v-arrikl-14061", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%PROGRAMFILES%\\RAPID7\\INSIGHT AGENT\\COMPONENTS\\INSIGHT_AGENT\\2.6.7.9\\GET_PROXY.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=RAPID7 LLC, L=BOSTON, S=MASSACHUSETTS, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%PROGRAMFILES%\\GOOGLE\\CHROME\\APPLICATION\\CHROME.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "O=GOOGLE LLC, L=MOUNTAIN VIEW, S=CA, C=US", - "productName": "GOOGLE CHROME", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "O=GOOGLE INC, L=MOUNTAIN VIEW, S=CALIFORNIA, C=US\\GOOGLE UPDATE\\*\\0.0.0.0", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "O=GOOGLE INC, L=MOUNTAIN VIEW, S=CALIFORNIA, C=US", - "productName": "GOOGLE UPDATE", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/providers/Microsoft.Security/locations/westeurope/applicationWhitelistings/GROUP1", - "name": "GROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "westeurope", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "executable": "Audit" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/nic-no-pip/providers/microsoft.compute/virtualmachines/nic-no-pip-vm", - "recommendationAction": "Recommended", - "enforcementSupport": "Unknown" - } - ], - "pathRecommendations": [ - { - "path": "/sbin/init", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/upstart-udev-bridge", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/lib/systemd/systemd-udevd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/upstart-socket-bridge", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/dhclient", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/python3.4", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/upstart-file-bridge", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/dbus-daemon", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "messagebus", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/lib/systemd/systemd-logind", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/getty", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/atd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/cron", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/acpid", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/sshd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/linux-lts-xenial-tools-4.4.0-103/hv_vss_daemon", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/linux-lts-xenial-tools-4.4.0-103/hv_kvp_daemon", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/nscd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "unscd", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/ntpd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "ntp", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/auoms/bin/auomscollect", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/omi/bin/omiserver", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/omi/bin/omiengine", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omi", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/omi/bin/omiagent", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/rsyslogd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "syslog", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/python2.7", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - }, - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/omsagent/ruby/bin/ruby", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/auoms/bin/auoms", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/local/qualys/cloud-agent/bin/qualys-cloud-agent", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/dash", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - }, - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/sleep", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/dsc/bin/dsc_host", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/sudo", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/bash", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/apt-get", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/apt/methods/http", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/apt/methods/gpgv", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/apt/methods/copy", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/pgrep", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/omsconfig/bin/omsconsistencyinvoker", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [ - { - "issue": "ExecutableViolationsAudited", - "numberOfVms": 1 - } - ], - "sourceSystem": "Azure_AuditD" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/PutApplicationWhitelistings_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/PutApplicationWhitelistings_example.json deleted file mode 100644 index da0aa89f8c4e..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ApplicationWhitelistings/PutApplicationWhitelistings_example.json +++ /dev/null @@ -1,232 +0,0 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154baf", - "groupName": "ERELGROUP1", - "ascLocation": "centralus", - "body": { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/ERELGROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "name": "ERELGROUP1", - "properties": { - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/matanvs/providers/microsoft.compute/virtualmachines/matanvs19", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\PACKAGES_201973_7415\\COLLECTGUESTLOGS.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "C:\\directory\\file.exe", - "action": "Add", - "type": "File", - "common": true - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/ERELGROUP1", - "name": "ERELGROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended" - }, - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourcegroups/matanvs/providers/microsoft.compute/virtualmachines/matanvs19", - "recommendationAction": "Recommended" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\PACKAGES_201973_7415\\COLLECTGUESTLOGS.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "C:\\directory\\file.exe", - "type": "File", - "common": true, - "action": "Add", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "NotConfigured" - } - ], - "configurationStatus": "InProgress", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json deleted file mode 100644 index 2ebdf5f5f558..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json +++ /dev/null @@ -1,416 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Defender for Cloud", - "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider", - "version": "2020-01-01" - }, - "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/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings": { - "get": { - "x-ms-examples": { - "List Adaptive Network Hardenings resources of an extended resource": { - "$ref": "./examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json" - } - }, - "description": "Gets a list of Adaptive Network Hardenings resources in scope of an extended resource.", - "tags": [ - "AdaptiveNetworkHardenings" - ], - "operationId": "AdaptiveNetworkHardenings_ListByExtendedResource", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardeningsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}": { - "get": { - "x-ms-examples": { - "Get a single Adaptive Network Hardening resource": { - "$ref": "./examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json" - } - }, - "tags": [ - "AdaptiveNetworkHardenings" - ], - "description": "Gets a single Adaptive Network Hardening resource", - "operationId": "AdaptiveNetworkHardenings_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardening" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}/{adaptiveNetworkHardeningEnforceAction}": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Enforces the given rules on the NSG(s) listed in the request": { - "$ref": "./examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json" - } - }, - "tags": [ - "AdaptiveNetworkHardenings" - ], - "description": "Enforces the given rules on the NSG(s) listed in the request", - "operationId": "AdaptiveNetworkHardenings_Enforce", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceAction" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceRequest" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "PortNumber": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "Rule": { - "description": "Describes remote addresses that is recommended to communicate with the Azure resource on some (Protocol, Port, Direction). All other remote addresses are recommended to be blocked", - "properties": { - "name": { - "description": "The name of the rule", - "type": "string" - }, - "direction": { - "description": "The rule's direction", - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ], - "x-ms-enum": { - "name": "direction", - "modelAsString": true - } - }, - "destinationPort": { - "description": "The rule's destination port", - "$ref": "#/definitions/PortNumber" - }, - "protocols": { - "description": "The rule's transport protocols", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TCP", - "UDP" - ], - "x-ms-enum": { - "name": "transportProtocol", - "modelAsString": true - } - } - }, - "ipAddresses": { - "description": "The remote IP addresses that should be able to communicate with the Azure resource on the rule's destination port and protocol", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "EffectiveNetworkSecurityGroups": { - "description": "Describes the Network Security Groups effective on a network interface", - "properties": { - "networkInterface": { - "description": "The Azure resource ID of the network interface", - "type": "string" - }, - "networkSecurityGroups": { - "description": "The Network Security Groups effective on the network interface", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "AdaptiveNetworkHardeningProperties": { - "description": "Adaptive Network Hardening resource properties", - "properties": { - "rules": { - "description": "The security rules which are recommended to be effective on the VM", - "type": "array", - "items": { - "$ref": "#/definitions/Rule" - } - }, - "rulesCalculationTime": { - "type": "string", - "format": "date-time", - "description": "The UTC time on which the rules were calculated" - }, - "effectiveNetworkSecurityGroups": { - "description": "The Network Security Groups effective on the network interfaces of the protected resource", - "type": "array", - "items": { - "$ref": "#/definitions/EffectiveNetworkSecurityGroups" - } - } - } - }, - "AdaptiveNetworkHardening": { - "description": "The resource whose properties describes the Adaptive Network Hardening settings for some Azure resource", - "properties": { - "properties": { - "description": "Properties of the Adaptive Network Hardening resource", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AdaptiveNetworkHardeningProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "AdaptiveNetworkHardeningsList": { - "description": "Response for ListAdaptiveNetworkHardenings API service call", - "properties": { - "value": { - "description": "A list of Adaptive Network Hardenings resources", - "type": "array", - "items": { - "$ref": "#/definitions/AdaptiveNetworkHardening" - } - }, - "nextLink": { - "description": "The URL to get the next set of results", - "type": "string" - } - } - }, - "AdaptiveNetworkHardeningEnforceRequest": { - "type": "object", - "properties": { - "rules": { - "type": "array", - "description": "The rules to enforce", - "items": { - "$ref": "#/definitions/Rule" - } - }, - "networkSecurityGroups": { - "type": "array", - "description": "The Azure resource IDs of the effective network security groups that will be updated with the created security rules from the Adaptive Network Hardening rules", - "items": { - "type": "string" - } - } - }, - "required": [ - "rules", - "networkSecurityGroups" - ] - } - }, - "parameters": { - "AdaptiveNetworkHardeningResourceName": { - "name": "adaptiveNetworkHardeningResourceName", - "in": "path", - "description": "The name of the Adaptive Network Hardening resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AdaptiveNetworkHardeningEnforceAction": { - "name": "adaptiveNetworkHardeningEnforceAction", - "type": "string", - "in": "path", - "required": true, - "description": "Enforces the given rules on the NSG(s) listed in the request", - "enum": [ - "enforce" - ], - "x-ms-enum": { - "name": "AdaptiveNetworkHardeningEnforceAction", - "modelAsString": false - }, - "x-ms-parameter-location": "method" - }, - "AdaptiveNetworkHardeningEnforceRequest": { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardeningEnforceRequest" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json deleted file mode 100644 index 41665347997e..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json +++ /dev/null @@ -1,576 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Defender for Cloud", - "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider", - "version": "2020-01-01" - }, - "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}/providers/Microsoft.Security/applicationWhitelistings": { - "get": { - "description": "Gets a list of application control machine groups for the subscription.", - "operationId": "AdaptiveApplicationControls_List", - "x-ms-examples": { - "Gets a list of application control groups of machines for the subscription": { - "$ref": "./examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsSubscription_example.json" - } - }, - "tags": [ - "applicationWhitelistings" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IncludePathRecommendations" - }, - { - "$ref": "#/parameters/Summary" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveApplicationControlGroups" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/applicationWhitelistings/{groupName}": { - "get": { - "description": "Gets an application control VM/server group.", - "operationId": "AdaptiveApplicationControls_Get", - "x-ms-examples": { - "Gets a configured application control VM/server group": { - "$ref": "./examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsGroup_example.json" - } - }, - "tags": [ - "applicationWhitelistings" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/GroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveApplicationControlGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "applicationWhitelistings" - ], - "x-ms-examples": { - "Update an application control machine group by adding a new application": { - "$ref": "./examples/ApplicationWhitelistings/PutAdaptiveApplicationControls_example.json" - } - }, - "description": "Update an application control machine group", - "operationId": "AdaptiveApplicationControls_Put", - "consumes": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/GroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/AdaptiveApplicationControlGroup" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveApplicationControlGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an application control machine group": { - "$ref": "./examples/ApplicationWhitelistings/DeleteAdaptiveApplicationControls_example.json" - } - }, - "tags": [ - "applicationWhitelistings" - ], - "description": "Delete an application control machine group", - "operationId": "AdaptiveApplicationControls_Delete", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/GroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK - The response indicates that the delete operation completed successfully" - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "No Content. The response indicates the resource is already deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "AdaptiveApplicationControlGroups": { - "type": "object", - "description": "Represents a list of VM/server groups and set of rules that are Recommended by Microsoft Defender for Cloud to be allowed", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AdaptiveApplicationControlGroup" - } - } - } - }, - "AdaptiveApplicationControlGroup": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AdaptiveApplicationControlGroupData" - } - }, - "required": [ - "properties" - ], - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - }, - { - "$ref": "../../../common/v1/types.json#/definitions/Location" - } - ] - }, - "AdaptiveApplicationControlGroupData": { - "type": "object", - "description": "Represents a machines group and set of rules to be allowed running on a machine", - "properties": { - "enforcementMode": { - "$ref": "#/definitions/EnforcementMode" - }, - "protectionMode": { - "$ref": "#/definitions/ProtectionMode" - }, - "configurationStatus": { - "readOnly": true, - "$ref": "#/definitions/ConfigurationStatus" - }, - "recommendationStatus": { - "readOnly": true, - "$ref": "#/definitions/RecommendationStatus" - }, - "issues": { - "readOnly": true, - "$ref": "#/definitions/AdaptiveApplicationControlIssuesSummaries" - }, - "sourceSystem": { - "readOnly": true, - "$ref": "#/definitions/SourceSystem" - }, - "vmRecommendations": { - "$ref": "#/definitions/VmRecommendations" - }, - "pathRecommendations": { - "$ref": "#/definitions/PathRecommendations" - } - } - }, - "ConfigurationStatus": { - "type": "string", - "description": "The configuration status of the machines group or machine or rule", - "enum": [ - "Configured", - "NotConfigured", - "InProgress", - "Failed", - "NoStatus" - ] - }, - "EnforcementMode": { - "type": "string", - "description": "The application control policy enforcement/protection mode of the machine group", - "enum": [ - "Audit", - "Enforce", - "None" - ] - }, - "EnforcementSupport": { - "type": "string", - "description": "The machine supportability of Enforce feature", - "enum": [ - "Supported", - "NotSupported", - "Unknown" - ] - }, - "ProtectionMode": { - "type": "object", - "description": "The protection mode of the collection/file types. Exe/Msi/Script are used for Windows, Executable is used for Linux.", - "properties": { - "exe": { - "$ref": "#/definitions/EnforcementMode" - }, - "msi": { - "$ref": "#/definitions/EnforcementMode" - }, - "script": { - "$ref": "#/definitions/EnforcementMode" - }, - "executable": { - "$ref": "#/definitions/EnforcementMode" - } - } - }, - "RecommendationStatus": { - "type": "string", - "description": "The initial recommendation status of the machine group or machine", - "enum": [ - "Recommended", - "NotRecommended", - "NotAvailable", - "NoStatus" - ] - }, - "RecommendationAction": { - "type": "string", - "description": "The recommendation action of the machine or rule", - "enum": [ - "Recommended", - "Add", - "Remove" - ] - }, - "RecommendationType": { - "type": "string", - "description": "The type of the rule to be allowed", - "enum": [ - "File", - "FileHash", - "PublisherSignature", - "ProductSignature", - "BinarySignature", - "VersionAndAboveSignature" - ] - }, - "AdaptiveApplicationControlIssue": { - "type": "string", - "description": "An alert that machines within a group can have", - "enum": [ - "ViolationsAudited", - "ViolationsBlocked", - "MsiAndScriptViolationsAudited", - "MsiAndScriptViolationsBlocked", - "ExecutableViolationsAudited", - "RulesViolatedManually" - ] - }, - "FileType": { - "type": "string", - "description": "The type of the file (for Linux files - Executable is used)", - "enum": [ - "Exe", - "Dll", - "Msi", - "Script", - "Executable", - "Unknown" - ] - }, - "SourceSystem": { - "type": "string", - "description": "The source type of the machine group", - "enum": [ - "Azure_AppLocker", - "Azure_AuditD", - "NonAzure_AppLocker", - "NonAzure_AuditD", - "None" - ] - }, - "AdaptiveApplicationControlIssueSummary": { - "type": "object", - "description": "Represents a summary of the alerts of the machine group", - "properties": { - "issue": { - "$ref": "#/definitions/AdaptiveApplicationControlIssue" - }, - "numberOfVms": { - "type": "number", - "description": "The number of machines in the group that have this alert" - } - } - }, - "AdaptiveApplicationControlIssuesSummaries": { - "type": "array", - "items": { - "$ref": "#/definitions/AdaptiveApplicationControlIssueSummary" - } - }, - "VmRecommendations": { - "type": "array", - "items": { - "$ref": "#/definitions/VmRecommendation" - } - }, - "VmRecommendation": { - "type": "object", - "description": "Represents a machine that is part of a machine group", - "properties": { - "configurationStatus": { - "$ref": "#/definitions/ConfigurationStatus" - }, - "recommendationAction": { - "$ref": "#/definitions/RecommendationAction" - }, - "resourceId": { - "$ref": "#/definitions/VmResourceId" - }, - "enforcementSupport": { - "$ref": "#/definitions/EnforcementSupport" - } - } - }, - "PublisherInfo": { - "type": "object", - "description": "Represents the publisher information of a process/rule", - "properties": { - "publisherName": { - "type": "string", - "description": "The Subject field of the x.509 certificate used to sign the code, using the following fields - O = Organization, L = Locality, S = State or Province, and C = Country", - "example": "O=GOOGLE INC, L=MOUNTAIN VIEW, S=CALIFORNIA, C=US" - }, - "productName": { - "type": "string", - "description": "The product name taken from the file's version resource", - "example": "GOOGLE CHROME" - }, - "binaryName": { - "type": "string", - "description": "The \"OriginalName\" field taken from the file's version resource", - "example": "CHROME.EXE" - }, - "version": { - "type": "string", - "description": "The binary file version taken from the file's version resource", - "example": "66.0.3359.139" - } - } - }, - "UserRecommendation": { - "type": "object", - "description": "Represents a user that is recommended to be allowed for a certain rule", - "properties": { - "username": { - "type": "string", - "description": "Represents a user that is recommended to be allowed for a certain rule", - "example": "LOCAL SYSTEM" - }, - "recommendationAction": { - "$ref": "#/definitions/RecommendationAction" - } - } - }, - "PathRecommendations": { - "type": "array", - "items": { - "$ref": "#/definitions/PathRecommendation" - } - }, - "PathRecommendation": { - "type": "object", - "description": "Represents a path that is recommended to be allowed and its properties", - "properties": { - "path": { - "type": "string", - "description": "The full path of the file, or an identifier of the application", - "example": "C:\\Windows\\System32\\calc.exe" - }, - "action": { - "$ref": "#/definitions/RecommendationAction" - }, - "type": { - "$ref": "#/definitions/RecommendationType" - }, - "publisherInfo": { - "$ref": "#/definitions/PublisherInfo" - }, - "common": { - "type": "boolean", - "description": "Whether the application is commonly run on the machine" - }, - "userSids": { - "type": "array", - "items": { - "type": "string", - "description": "A security identifier", - "example": "S-1-5-18" - } - }, - "usernames": { - "type": "array", - "items": { - "$ref": "#/definitions/UserRecommendation" - } - }, - "fileType": { - "$ref": "#/definitions/FileType" - }, - "configurationStatus": { - "$ref": "#/definitions/ConfigurationStatus" - } - } - }, - "GroupResourceId": { - "type": "string", - "description": "The azure resource id of the application control machine group", - "example": "/subscriptions/12345678-1234-1234-1234-123456789123/providers/Microsoft.Security/applicationWhitelistings/GROUP1" - }, - "VmResourceId": { - "type": "string", - "description": "The full resource id of the machine", - "example": "/subscriptions/12345678-1234-1234-1234-123456789123/resourcegroups/group/providers/microsoft.compute/virtualmachines/vm" - } - }, - "parameters": { - "GroupName": { - "name": "groupName", - "in": "path", - "description": "Name of an application control machine group", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "IncludePathRecommendations": { - "name": "includePathRecommendations", - "in": "query", - "description": "Include the policy rules", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "Summary": { - "name": "summary", - "in": "query", - "description": "Return output in a summarized form", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "AdaptiveApplicationControlGroup": { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AdaptiveApplicationControlGroup" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json deleted file mode 100644 index dcaf5b9bdbbe..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1", - "adaptiveNetworkHardeningResourceName": "default", - "adaptiveNetworkHardeningEnforceAction": "enforce", - "body": { - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg2" - ] - } - }, - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json deleted file mode 100644 index be1d1f990c52..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1", - "adaptiveNetworkHardeningResourceName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", - "name": "default", - "type": "Microsoft.Security/adaptiveNetworkHardenings", - "properties": { - "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "effectiveNetworkSecurityGroups": [ - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" - ] - }, - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg2/providers/Microsoft.Network/networkInterfaces/nic2", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nicNsg" - ] - } - ] - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json deleted file mode 100644 index 76eadc462fe8..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", - "name": "default", - "type": "Microsoft.Security/adaptiveNetworkHardenings", - "properties": { - "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "effectiveNetworkSecurityGroups": [ - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" - ] - }, - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic2", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg2" - ] - } - ] - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/DeleteAdaptiveApplicationControls_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/DeleteAdaptiveApplicationControls_example.json deleted file mode 100644 index bd31aa457af2..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/DeleteAdaptiveApplicationControls_example.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "groupName": "GROUP1", - "ascLocation": "centralus" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsGroup_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsGroup_example.json deleted file mode 100644 index 1270432ac816..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsGroup_example.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "centralus", - "groupName": "ERELGROUP1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/ERELGROUP1", - "name": "ERELGROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "Audit", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/matanvs/providers/microsoft.compute/virtualmachines/matanvs19", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\PACKAGES_201973_7415\\COLLECTGUESTLOGS.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "C:\\directory\\file.exe", - "type": "File", - "common": true, - "action": "Add", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsSubscription_example.json deleted file mode 100644 index e61f53c406f4..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/GetAdaptiveApplicationControlsSubscription_example.json +++ /dev/null @@ -1,1028 +0,0 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "includePathRecommendations": true, - "summary": false - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/AMIT-VA", - "name": "AMIT-VA", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "Audit", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/erelh-dsc/providers/microsoft.compute/virtualmachines/erelh-14011", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/amit-va/providers/microsoft.compute/virtualmachines/ream-test", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/v-arrikl-scheduledapps/providers/microsoft.compute/virtualmachines/v-arrikl-14060", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "C:\\Windows\\SoftwareDistribution\\Download\\Install\\Windows-KB890830-x64-V5.53-delta.exe", - "type": "File", - "common": true, - "action": "Remove", - "usernames": [ - { - "username": "LOCAL SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-5-18" - ], - "fileType": "Exe", - "configurationStatus": "NoStatus" - }, - { - "path": "C:\\WindowsAzure\\GuestAgent_2.7.1198.822\\CollectGuestLogs.exe", - "type": "File", - "common": true, - "action": "Remove", - "usernames": [ - { - "username": "LOCAL SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-5-18" - ], - "fileType": "Exe", - "configurationStatus": "NoStatus" - }, - { - "path": "C:\\Windows\\System32\\wbem\\WmiPrvSE.exe", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-5-18", - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/ERELGROUP1", - "name": "ERELGROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended", - "enforcementSupport": "NotSupported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/GROUP1", - "name": "GROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/talk-va/providers/microsoft.compute/virtualmachines/tal-win-vm", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/talk-va/providers/microsoft.compute/virtualmachines/tal-win-vm-jit", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myresourcegroup/providers/microsoft.compute/virtualmachines/myvmweb", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/v-arrikl-scheduledapps/providers/microsoft.compute/virtualmachines/v-arrikl-14061", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%PROGRAMFILES%\\RAPID7\\INSIGHT AGENT\\COMPONENTS\\INSIGHT_AGENT\\2.6.7.9\\GET_PROXY.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=RAPID7 LLC, L=BOSTON, S=MASSACHUSETTS, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%PROGRAMFILES%\\GOOGLE\\CHROME\\APPLICATION\\CHROME.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "O=GOOGLE LLC, L=MOUNTAIN VIEW, S=CA, C=US", - "productName": "GOOGLE CHROME", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "O=GOOGLE INC, L=MOUNTAIN VIEW, S=CALIFORNIA, C=US\\GOOGLE UPDATE\\*\\0.0.0.0", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "O=GOOGLE INC, L=MOUNTAIN VIEW, S=CALIFORNIA, C=US", - "productName": "GOOGLE UPDATE", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/applicationWhitelistings/GROUP1", - "name": "GROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "westeurope", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "executable": "Audit" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/nic-no-pip/providers/microsoft.compute/virtualmachines/nic-no-pip-vm", - "recommendationAction": "Recommended", - "enforcementSupport": "Unknown" - } - ], - "pathRecommendations": [ - { - "path": "/sbin/init", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/upstart-udev-bridge", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/lib/systemd/systemd-udevd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/upstart-socket-bridge", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/dhclient", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/python3.4", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/upstart-file-bridge", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/dbus-daemon", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "messagebus", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/lib/systemd/systemd-logind", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/sbin/getty", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/atd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/cron", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/acpid", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/sshd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/linux-lts-xenial-tools-4.4.0-103/hv_vss_daemon", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/linux-lts-xenial-tools-4.4.0-103/hv_kvp_daemon", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/nscd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "unscd", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/ntpd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "ntp", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/auoms/bin/auomscollect", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/omi/bin/omiserver", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/omi/bin/omiengine", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omi", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/omi/bin/omiagent", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/sbin/rsyslogd", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "syslog", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/python2.7", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - }, - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/omsagent/ruby/bin/ruby", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/auoms/bin/auoms", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/local/qualys/cloud-agent/bin/qualys-cloud-agent", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/dash", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - }, - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/sleep", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/dsc/bin/dsc_host", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/sudo", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/bin/bash", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/apt-get", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/apt/methods/http", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/apt/methods/gpgv", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/lib/apt/methods/copy", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "root", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/usr/bin/pgrep", - "type": "File", - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - }, - { - "path": "/opt/microsoft/omsconfig/bin/omsconsistencyinvoker", - "type": "File", - "common": false, - "action": "Recommended", - "usernames": [ - { - "username": "omsagent", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Executable", - "configurationStatus": "Configured" - } - ], - "configurationStatus": "Configured", - "issues": [ - { - "issue": "ExecutableViolationsAudited", - "numberOfVms": 1 - } - ], - "sourceSystem": "Azure_AuditD" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/PutAdaptiveApplicationControls_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/PutAdaptiveApplicationControls_example.json deleted file mode 100644 index 043e6895f54c..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ApplicationWhitelistings/PutAdaptiveApplicationControls_example.json +++ /dev/null @@ -1,229 +0,0 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "centralus", - "groupName": "ERELGROUP1", - "body": { - "properties": { - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - }, - { - "configurationStatus": "Configured", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/matanvs/providers/microsoft.compute/virtualmachines/matanvs19", - "recommendationAction": "Recommended", - "enforcementSupport": "Supported" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\PACKAGES_201973_7415\\COLLECTGUESTLOGS.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "C:\\directory\\file.exe", - "action": "Add", - "type": "File", - "common": true - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/ERELGROUP1", - "name": "ERELGROUP1", - "type": "Microsoft.Security/applicationWhitelistings", - "location": "centralus", - "properties": { - "recommendationStatus": "Recommended", - "enforcementMode": "Audit", - "protectionMode": { - "exe": "Audit", - "msi": "None", - "script": "None" - }, - "vmRecommendations": [ - { - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/erelh-stable/providers/microsoft.compute/virtualmachines/erelh-16090", - "recommendationAction": "Recommended" - }, - { - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/matanvs/providers/microsoft.compute/virtualmachines/matanvs19", - "recommendationAction": "Recommended" - } - ], - "pathRecommendations": [ - { - "path": "[Exe] O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US\\*\\*\\0.0.0.0", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "O=MICROSOFT CORPORATION, L=REDMOND, S=WASHINGTON, C=US", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\SECAGENT\\WASECAGENTPROV.EXE", - "type": "ProductSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "MICROSOFT® COREXT", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "%OSDRIVE%\\WINDOWSAZURE\\PACKAGES_201973_7415\\COLLECTGUESTLOGS.EXE", - "type": "PublisherSignature", - "publisherInfo": { - "publisherName": "CN=MICROSOFT AZURE DEPENDENCY CODE SIGN", - "productName": "*", - "binaryName": "*", - "version": "0.0.0.0" - }, - "common": true, - "action": "Recommended", - "usernames": [ - { - "username": "NT AUTHORITY\\SYSTEM", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "Configured" - }, - { - "path": "C:\\directory\\file.exe", - "type": "File", - "common": true, - "action": "Add", - "usernames": [ - { - "username": "Everyone", - "recommendationAction": "Recommended" - } - ], - "userSids": [ - "S-1-1-0" - ], - "fileType": "Exe", - "configurationStatus": "NotConfigured" - } - ], - "configurationStatus": "InProgress", - "issues": [], - "sourceSystem": "Azure_AppLocker" - } - } - } - } -} diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 93f5f8749ce4..d180b8ab36dc 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -395,10 +395,8 @@ These settings apply only when `--tag=package-composite-v1` is specified on the ``` yaml $(tag) == 'package-composite-v1' input-file: -- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json - Microsoft.Security/preview/2015-06-01-preview/alerts.json - Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json -- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json - Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json - Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json - Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json @@ -440,9 +438,7 @@ These settings apply only when `--tag=package-composite-v2` is specified on the ``` yaml $(tag) == 'package-composite-v2' input-file: -- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json - Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json -- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json - Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json - Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json - Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json @@ -522,9 +518,7 @@ input-file: - Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json -- Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json - Microsoft.Security/stable/2020-01-01/allowedConnections.json -- Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json - Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json - Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json - Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json @@ -599,9 +593,7 @@ input-file: - Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json -- Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json - Microsoft.Security/stable/2020-01-01/allowedConnections.json -- Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json - Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json - Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json - Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json @@ -645,10 +637,8 @@ These settings apply only when `--tag=package-2015-06-preview-only` is specified ``` yaml $(tag) == 'package-2015-06-preview-only' input-file: -- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json - Microsoft.Security/preview/2015-06-01-preview/alerts.json - Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json -- Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json - Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json - Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json - Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json @@ -854,9 +844,7 @@ These settings apply only when `--tag=package-2020-01-python-only` is specified ``` yaml $(tag) == 'package-2020-01-python-only' input-file: -- Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json - Microsoft.Security/stable/2020-01-01/allowedConnections.json -- Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json - Microsoft.Security/stable/2020-01-01/assessmentMetadata.json - Microsoft.Security/stable/2020-01-01/assessments.json - Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json @@ -879,10 +867,8 @@ These settings apply only when `--tag=package-2020-01-only` is specified on the ``` yaml $(tag) == 'package-2020-01-only' input-file: -- Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json - Microsoft.Security/stable/2020-01-01/alerts.json - Microsoft.Security/stable/2020-01-01/allowedConnections.json -- Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json - Microsoft.Security/stable/2020-01-01/assessmentMetadata.json - Microsoft.Security/stable/2020-01-01/assessments.json - Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json diff --git a/specification/security/resource-manager/sdk-suppressions.yaml b/specification/security/resource-manager/sdk-suppressions.yaml index 896fc8cc0bf4..ac8fdf07c27e 100644 --- a/specification/security/resource-manager/sdk-suppressions.yaml +++ b/specification/security/resource-manager/sdk-suppressions.yaml @@ -10,3 +10,5 @@ suppressions: - Model DefenderForStorageSetting no longer has parameter operation_status_properties_sensitive_data_discovery_operation_status - Model DefenderForStorageSetting no longer has parameter override_subscription_level_settings - Model DefenderForStorageSetting no longer has parameter scan_results_event_grid_topic_resource_id + - Removed operation group AdaptiveApplicationControlsOperations + - Removed operation group AdaptiveNetworkHardeningsOperations From e45cb6ba21b5bdac766e789d643abdc2fa87b73b Mon Sep 17 00:00:00 2001 From: vrusheshp <113632994+vrusheshp@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:12:47 -0700 Subject: [PATCH 19/30] arc vm 2408.1 change (#30256) * arc vm 2408.1 change * add modified 2024-02-01 json * add spaces for typespec valiation * update readme * update missed tag to 2024-05 * update readme and address operations.list being moved * remove nonreferenced file * remove unused file * rename to gpuName * Update sdk-suppressions.yaml * add suppression info --------- Co-authored-by: Vrushesh Patel Co-authored-by: shraddhasun <128851887+shraddhasun@users.noreply.github.com> Co-authored-by: Yuchao Yan --- .../AttestationStatuses_Get.json | 26 + .../GalleryImages_CreateOrUpdate.json | 100 + .../GalleryImages_CreateOrUpdate_FromVM.json | 100 + .../GalleryImages_Delete.json | 22 + .../2024-05-01-preview/GalleryImages_Get.json | 56 + .../GalleryImages_ListAll.json | 52 + .../GalleryImages_ListByResourceGroup.json | 53 + .../GalleryImages_Update.json | 63 + .../GuestAgents_Create.json | 43 + .../GuestAgents_Delete.json | 20 + .../2024-05-01-preview/GuestAgents_Get.json | 22 + ...stAgents_ListByVirtualMachineInstance.json | 26 + .../HybridIdentityMetadataGroup_Get.json | 25 + ...Metadata_ListByVirtualMachineInstance.json | 29 + .../LogicalNetworks_CreateOrUpdate.json | 49 + .../LogicalNetworks_Delete.json | 22 + .../LogicalNetworks_Get.json | 27 + .../LogicalNetworks_ListAll.json | 29 + .../LogicalNetworks_ListByResourceGroup.json | 30 + .../LogicalNetworks_Update.json | 40 + ...rketplaceGalleryImages_CreateOrUpdate.json | 122 + .../MarketplaceGalleryImages_Delete.json | 22 + .../MarketplaceGalleryImages_Get.json | 56 + .../MarketplaceGalleryImages_ListAll.json | 58 + ...laceGalleryImages_ListByResourceGroup.json | 59 + .../MarketplaceGalleryImages_Update.json | 69 + .../NetworkInterfaces_CreateOrUpdate.json | 81 + .../NetworkInterfaces_Delete.json | 22 + .../NetworkInterfaces_Get.json | 37 + .../NetworkInterfaces_ListAll.json | 41 + ...NetworkInterfaces_ListByResourceGroup.json | 41 + .../NetworkInterfaces_Update.json | 47 + .../NetworkSecurityGroups_CreateOrUpdate.json | 37 + .../NetworkSecurityGroups_Delete.json | 22 + .../NetworkSecurityGroups_Get.json | 23 + .../NetworkSecurityGroups_ListAll.json | 34 + ...orkSecurityGroups_ListByResourceGroup.json | 35 + .../NetworkSecurityGroups_UpdateTags.json | 38 + .../SecurityRules_CreateOrUpdate.json | 85 + .../SecurityRules_Delete.json | 23 + .../2024-05-01-preview/SecurityRules_Get.json | 37 + ...urityRules_ListByNetworkSecurityGroup.json | 40 + .../StorageContainers_CreateOrUpdate.json | 54 + .../StorageContainers_Delete.json | 22 + .../StorageContainers_Get.json | 28 + .../StorageContainers_ListAll.json | 30 + ...StorageContainers_ListByResourceGroup.json | 31 + .../StorageContainers_Update.json | 41 + .../VirtualHardDisks_CreateOrUpdate.json | 66 + .../VirtualHardDisks_Delete.json | 22 + .../VirtualHardDisks_Download.json | 66 + .../VirtualHardDisks_Get.json | 34 + .../VirtualHardDisks_ListAll.json | 36 + .../VirtualHardDisks_ListByResourceGroup.json | 37 + .../VirtualHardDisks_Update.json | 47 + .../VirtualHardDisks_Upload.json | 29 + ...l_Machine_Instance_With_Gallery_Image.json | 115 + ...Put_Virtual_Machine_Instance_With_Gpu.json | 133 + ...stance_With_Marketplace_Gallery_Image.json | 115 + ...Virtual_Machine_Instance_With_Os_Disk.json | 102 + ...Machine_Instance_With_Vm_Config_Agent.json | 146 + .../VirtualMachineInstances_Delete.json | 20 + .../VirtualMachineInstances_Get.json | 44 + .../VirtualMachineInstances_List.json | 48 + .../VirtualMachineInstances_Pause.json | 15 + .../VirtualMachineInstances_Restart.json | 15 + .../VirtualMachineInstances_Save.json | 15 + .../VirtualMachineInstances_Start.json | 15 + .../VirtualMachineInstances_Stop.json | 15 + .../VirtualMachineInstances_Update.json | 64 + .../main.tsp | 10 +- .../models.tsp | 104 +- .../2024-05-01-preview}/Operations_List.json | 2 +- .../Operations.Management/main.tsp | 7 + .../2024-02-01-preview/stackhcivm.json | 39 - .../examples/AttestationStatuses_Get.json | 26 + .../GalleryImages_CreateOrUpdate.json | 100 + .../examples/GalleryImages_Delete.json | 22 + .../examples/GalleryImages_Get.json | 56 + .../examples/GalleryImages_ListAll.json | 52 + .../GalleryImages_ListByResourceGroup.json | 53 + .../examples/GalleryImages_Update.json | 63 + .../examples/GuestAgents_Create.json | 43 + .../examples/GuestAgents_Delete.json | 20 + .../examples/GuestAgents_Get.json | 22 + ...stAgents_ListByVirtualMachineInstance.json | 26 + .../HybridIdentityMetadataGroup_Get.json | 25 + ...Metadata_ListByVirtualMachineInstance.json | 29 + .../LogicalNetworks_CreateOrUpdate.json | 49 + .../examples/LogicalNetworks_Delete.json | 22 + .../examples/LogicalNetworks_Get.json | 27 + .../examples/LogicalNetworks_ListAll.json | 29 + .../LogicalNetworks_ListByResourceGroup.json | 30 + .../examples/LogicalNetworks_Update.json | 40 + ...rketplaceGalleryImages_CreateOrUpdate.json | 122 + .../MarketplaceGalleryImages_Delete.json | 22 + .../MarketplaceGalleryImages_Get.json | 56 + .../MarketplaceGalleryImages_ListAll.json | 58 + ...laceGalleryImages_ListByResourceGroup.json | 59 + .../MarketplaceGalleryImages_Update.json | 69 + .../NetworkInterfaces_CreateOrUpdate.json | 81 + .../examples/NetworkInterfaces_Delete.json | 22 + .../examples/NetworkInterfaces_Get.json | 37 + .../examples/NetworkInterfaces_ListAll.json | 41 + ...NetworkInterfaces_ListByResourceGroup.json | 41 + .../examples/NetworkInterfaces_Update.json | 47 + .../NetworkSecurityGroups_CreateOrUpdate.json | 37 + .../NetworkSecurityGroups_Delete.json | 22 + .../examples/NetworkSecurityGroups_Get.json | 23 + .../NetworkSecurityGroups_ListAll.json | 34 + ...orkSecurityGroups_ListByResourceGroup.json | 35 + .../NetworkSecurityGroups_UpdateTags.json | 38 + .../SecurityRules_CreateOrUpdate.json | 85 + .../examples/SecurityRules_Delete.json | 23 + .../examples/SecurityRules_Get.json | 37 + ...urityRules_ListByNetworkSecurityGroup.json | 40 + .../StorageContainers_CreateOrUpdate.json | 54 + .../examples/StorageContainers_Delete.json | 22 + .../examples/StorageContainers_Get.json | 28 + .../examples/StorageContainers_ListAll.json | 30 + ...StorageContainers_ListByResourceGroup.json | 31 + .../examples/StorageContainers_Update.json | 41 + .../VirtualHardDisks_CreateOrUpdate.json | 66 + .../examples/VirtualHardDisks_Delete.json | 22 + .../examples/VirtualHardDisks_Get.json | 34 + .../examples/VirtualHardDisks_ListAll.json | 36 + .../VirtualHardDisks_ListByResourceGroup.json | 37 + .../examples/VirtualHardDisks_Update.json | 47 + ...l_Machine_Instance_With_Gallery_Image.json | 115 + ...Put_Virtual_Machine_Instance_With_Gpu.json | 133 + ...stance_With_Marketplace_Gallery_Image.json | 115 + ...Virtual_Machine_Instance_With_Os_Disk.json | 102 + ...Machine_Instance_With_Vm_Config_Agent.json | 146 + .../VirtualMachineInstances_Delete.json | 20 + .../examples/VirtualMachineInstances_Get.json | 44 + .../VirtualMachineInstances_List.json | 48 + .../VirtualMachineInstances_Pause.json | 15 + .../VirtualMachineInstances_Restart.json | 15 + .../VirtualMachineInstances_Save.json | 15 + .../VirtualMachineInstances_Start.json | 15 + .../VirtualMachineInstances_Stop.json | 15 + .../VirtualMachineInstances_Update.json | 64 + .../2024-05-01-preview/stackhcivm.json | 7146 +++++++++++++++++ .../StackHCIVM/readme.md | 18 +- .../examples/Operations_List.json | 2 +- .../2024-05-01-preview/operations.json | 86 + .../resource-manager/sdk-suppressions.yaml | 82 +- 147 files changed, 13790 insertions(+), 47 deletions(-) create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/AttestationStatuses_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate_FromVM.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Create.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadataGroup_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_UpdateTags.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Download.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Upload.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_List.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Pause.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Restart.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Save.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Start.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Stop.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Update.json rename specification/azurestackhci/{AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview => Operations.Management/examples/2024-05-01-preview}/Operations_List.json (99%) create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/AttestationStatuses_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Create.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadataGroup_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_UpdateTags.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Pause.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Restart.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Save.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Start.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Stop.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json rename specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/{StackHCIVM/preview/2024-02-01-preview => operations/preview/2024-05-01-preview}/examples/Operations_List.json (99%) create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-05-01-preview/operations.json diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/AttestationStatuses_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/AttestationStatuses_Get.json new file mode 100644 index 000000000000..ebfe02b9793e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/AttestationStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/AttestationStatus", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default", + "properties": { + "attestSecureBootEnabled": "Disabled", + "attestationCertValidated": "Invalid", + "bootIntegrityValidated": "Invalid", + "errorMessage": "Attestation token has invalid signature", + "healthStatus": "Unhealthy", + "linuxKernelVersion": "1.0.0.0", + "timestamp": "2023/11/10 9:48" + } + } + } + }, + "operationId": "AttestationStatuses_Get", + "title": "GetAttestationStatus" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..3753c613e8ac --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "imagePath": "C:\\test.vhdx", + "osType": "Linux" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate", + "title": "PutGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate_FromVM.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate_FromVM.json new file mode 100644 index 000000000000..67122a2cc934 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_CreateOrUpdate_FromVM.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "sourceVirtualMachineId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualMachineInstance/test-vm", + "osType": "Windows" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate_FromVM", + "title": "PutGalleryImage_FromVM" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Delete.json new file mode 100644 index 000000000000..6620fe7b09c6 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Delete", + "title": "DeleteGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Get.json new file mode 100644 index 000000000000..d8af21613962 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_Get", + "title": "GetGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListAll.json new file mode 100644 index 000000000000..42b17730a248 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListAll", + "title": "ListGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..d744379400e8 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListByResourceGroup", + "title": "ListGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Update.json new file mode 100644 index 000000000000..49e9c04c3134 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GalleryImages_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Update", + "title": "UpdateGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Create.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Create.json new file mode 100644 index 000000000000..e2c29d92c260 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resource": { + "properties": { + "credentials": { + "password": "", + "username": "tempuser" + }, + "provisioningAction": "install" + } + }, + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Created", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Create", + "title": "CreateGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Delete.json new file mode 100644 index 000000000000..d9f3cb3b5ebe --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GuestAgents_Delete", + "title": "DeleteGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Get.json new file mode 100644 index 000000000000..03d02242c79c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Get", + "title": "GetGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_ListByVirtualMachineInstance.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..b67a60f9cf79 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/GuestAgents_ListByVirtualMachineInstance.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + ] + } + } + }, + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "title": "GuestAgentListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadataGroup_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadataGroup_Get.json new file mode 100644 index 000000000000..bd7ac1fdba37 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadataGroup_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + } + }, + "operationId": "HybridIdentityMetadata_Get", + "title": "GetHybridIdentityMetadata" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..98ed3a357d4e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + ] + } + } + }, + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "title": "HybridIdentityMetadataListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..c6c9cfa1f567 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2" + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "LogicalNetworks_CreateOrUpdate", + "title": "PutLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Delete.json new file mode 100644 index 000000000000..8ab565b35b91 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Delete", + "title": "DeleteLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Get.json new file mode 100644 index 000000000000..b2faecc0a2e6 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "LogicalNetworks_Get", + "title": "GetLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListAll.json new file mode 100644 index 000000000000..a41e7ddf2061 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListAll.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListAll", + "title": "ListLogicalNetworkBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..e07599d14080 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_ListByResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListByResourceGroup", + "title": "ListLogicalNetworkByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Update.json new file mode 100644 index 000000000000..2bcb54a19af2 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/LogicalNetworks_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Update", + "title": "UpdateLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..32ffbd23cd3a --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "name": "test-marketplace-gallery-image", + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "version": { + "name": "1.0.0" + } + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Creating", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "title": "PutMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Delete.json new file mode 100644 index 000000000000..c389d8e04126 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Delete", + "title": "DeleteMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Get.json new file mode 100644 index 000000000000..77ec0c7e19a4 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_Get", + "title": "GetMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListAll.json new file mode 100644 index 000000000000..84043b8e1a25 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListAll.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListAll", + "title": "ListMarketplaceGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..086d36275af7 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "title": "ListMarketplaceGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Update.json new file mode 100644 index 000000000000..e4bef1e4c84e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/MarketplaceGalleryImages_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplce-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Update", + "title": "UpdateMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_CreateOrUpdate.json new file mode 100644 index 000000000000..87662eb83c49 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ] + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "PutNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..05245254fbec --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Delete", + "title": "DeleteNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..1be4f9aaa256 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "NetworkInterfaces_Get", + "title": "GetNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListAll.json new file mode 100644 index 000000000000..6818854cdfbc --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListAll.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListAll", + "title": "ListNetworkInterfaceBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..4327e99db901 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListByResourceGroup", + "title": "ListNetworkInterfaceByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..f5ad9561a250 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkInterfaces_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Update", + "title": "UpdateNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..d86710b167a9 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "CreateNetworkSecurityGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Delete.json new file mode 100644 index 000000000000..ee7e041aa01a --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_Delete", + "title": "Delete network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Get.json new file mode 100644 index 000000000000..337d569cc85e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg1/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_Get", + "title": "Get network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListAll.json new file mode 100644 index 000000000000..26929e37f992 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg2", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg2/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg2", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListAll", + "title": "List all network security groups" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..8fe04612bbc5 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_ListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg3", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg3", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "title": "List network security groups in resource group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_UpdateTags.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_UpdateTags.json new file mode 100644 index 000000000000..fe640dd1586b --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/NetworkSecurityGroups_UpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_UpdateTags", + "title": "Update network security group tags" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_CreateOrUpdate.json new file mode 100644 index 000000000000..af11401c7a09 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_CreateOrUpdate", + "title": "SecurityRulesCreateOrUpdate" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Delete.json new file mode 100644 index 000000000000..8767216c5e9d --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "SecurityRules_Delete", + "title": "SecurityRulesDelete" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Get.json new file mode 100644 index 000000000000..8976a2ee9ac7 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_Get", + "title": "Get network security rule in network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..c702f1158ace --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/SecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + ] + } + } + }, + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "title": "List network security rules in network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_CreateOrUpdate.json new file mode 100644 index 000000000000..5634311112cc --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "path": "C:\\container_storage" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "StorageContainers_CreateOrUpdate", + "title": "PutStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Delete.json new file mode 100644 index 000000000000..a241173f505f --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Delete", + "title": "DeleteStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Get.json new file mode 100644 index 000000000000..385582d877a7 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "StorageContainers_Get", + "title": "GetStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListAll.json new file mode 100644 index 000000000000..0c946ce3464b --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListAll.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListAll", + "title": "ListStorageContainerBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListByResourceGroup.json new file mode 100644 index 000000000000..7a4cc6f39984 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListByResourceGroup", + "title": "ListStorageContainerByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Update.json new file mode 100644 index 000000000000..289083fcfe60 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/StorageContainers_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Update", + "title": "UpdateStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_CreateOrUpdate.json new file mode 100644 index 000000000000..8a1fff2cc916 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "diskSizeGB": 32 + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "PutVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Delete.json new file mode 100644 index 000000000000..a1ccb15ea179 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Delete", + "title": "DeleteVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Download.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Download.json new file mode 100644 index 000000000000..59a0c2eec97c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Download.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "downloadUrl": "https://YourStorageAccountName.blob.core.windows.net/YourContainerName/YourVHDBlobName.vhd?" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_Download", + "title": "DownloadVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Get.json new file mode 100644 index 000000000000..7457a6999fe9 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "VirtualHardDisks_Get", + "title": "GetVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListAll.json new file mode 100644 index 000000000000..7c4ca9fe919e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListAll", + "title": "ListVirtualHardDiskBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListByResourceGroup.json new file mode 100644 index 000000000000..736075b23852 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListByResourceGroup", + "title": "ListVirtualHardDiskByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Update.json new file mode 100644 index 000000000000..9ab9e513458d --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "properties": { + "tags": { + "additionalProperties": "sample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Update", + "title": "UpdateVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Upload.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Upload.json new file mode 100644 index 000000000000..62ec69041675 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualHardDisks_Upload.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "body": { + "azureManagedDiskUploadUrl": "https://YourStorageAccountName.blob.core.windows.net/YourContainerName/YourVHDBlobName.vhd?" + } + }, + "responses": { + "200": { + "body": { + "virtualHardDiskId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "uploadStatus": { + "uploadedSizeInMB": 10240, + "status": "InProgress" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + }, + "operationId": "VirtualHardDisks_Upload", + "title": "UploadVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json new file mode 100644 index 000000000000..bb4511224767 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json new file mode 100644 index 000000000000..6b590098cccf --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGpu" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json new file mode 100644 index 000000000000..c4347703d542 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json new file mode 100644 index 000000000000..b8eaef16b1db --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Succeeded", + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithOsDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json new file mode 100644 index 000000000000..daaf89aa9ba1 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster", + "windowsConfiguration": { + "provisionVMConfigAgent": true + } + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithVMConfigAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Delete.json new file mode 100644 index 000000000000..b947401fd488 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Delete", + "title": "DeleteVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Get.json new file mode 100644 index 000000000000..6cb37dc6842c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_Get", + "title": "GetVirtualMachineInstance" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_List.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_List.json new file mode 100644 index 000000000000..b2f90d5d05b5 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + ] + } + } + }, + "operationId": "VirtualMachineInstances_List", + "title": "ListVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Pause.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Pause.json new file mode 100644 index 000000000000..5cef0e76a571 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Pause.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Pause", + "title": "PauseVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Restart.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Restart.json new file mode 100644 index 000000000000..22341b12d2d3 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Restart", + "title": "RestartVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Save.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Save.json new file mode 100644 index 000000000000..9570f08f4518 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Save.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Save", + "title": "SaveVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Start.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Start.json new file mode 100644 index 000000000000..50f18ee80b67 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Start", + "title": "StartVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Stop.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Stop.json new file mode 100644 index 000000000000..c2385ed7dfdd --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Stop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Stop", + "title": "StopVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Update.json new file mode 100644 index 000000000000..c510a6b492fa --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-05-01-preview/VirtualMachineInstances_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "properties": { + "properties": { + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ], + "imageReference": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + } + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Update", + "title": "UpdateVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp index 296bc8508433..4ae2c9529641 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp @@ -16,8 +16,6 @@ import "./VirtualMachineInstance.tsp"; import "./HybridIdentityMetadata.tsp"; import "./AttestationStatus.tsp"; import "./GuestAgent.tsp"; -import "../Operations.Management/models.tsp"; - using TypeSpec.Rest; using TypeSpec.Http; using Azure.Core; @@ -27,6 +25,7 @@ using TypeSpec.Versioning; * Azure Stack HCI management service */ #suppress "@azure-tools/typespec-azure-core/casing-style" "HCI itself is a short form." +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Operations API is still spec'd, but now resides in another spec in this namespace." @armProviderNamespace @service({ title: "Microsoft.AzureStackHCI", @@ -45,4 +44,11 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_02_01_preview: "2024-02-01-preview", + + /** + * The 2024-05-01-preview API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_05_01_preview: "2024-05-01-preview", } diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp index 74430122d563..a229ff6911ef 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp @@ -2,12 +2,13 @@ import "@typespec/rest"; import "@typespec/http"; import "@azure-tools/typespec-azure-core"; import "@typespec/openapi"; +import "@typespec/versioning"; import "@azure-tools/typespec-azure-resource-manager"; -import "../Operations.Management/models.tsp"; using TypeSpec.Rest; using TypeSpec.Http; using Azure.Core; using TypeSpec.OpenAPI; +using TypeSpec.Versioning; using Azure.ResourceManager; namespace Microsoft.AzureStackHCI; @@ -214,6 +215,18 @@ union VmSizeEnum { string, } +@added(Versions.v2024_05_01_preview) +@doc("Gpu Assignment types") +union GpuAssignmentTypeEnum { + @doc("Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA)") + GpuDDA: "GpuDDA", + + @doc("Attach Graphics Processing Unit (GPU) using GPU Partitioning") + GpuP: "GpuP", + + string, +} + @doc("Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.") union SecurityTypes { @doc("Trusted Launch security type") @@ -501,6 +514,14 @@ model GalleryImageProperties { @doc("The observed state of gallery images") @visibility("read") status?: GalleryImageStatus; + + @added(Versions.v2024_05_01_preview) + @doc("Resource ID of the source virtual machine from whose OS disk the gallery image is created.") + sourceVirtualMachineId?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/virtualMachineInstance"; + } + ]>; } @doc("This is the gallery image definition identifier.") @@ -1069,6 +1090,11 @@ model VirtualHardDiskProperties { @doc("Physical sector in bytes") physicalSectorBytes?: int32; + @added(Versions.v2024_05_01_preview) + @doc("URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.") + @secret + downloadUrl?: string; + #suppress "@azure-tools/typespec-azure-core/casing-style" "HyperV is the correct case." @doc("The hypervisor generation of the Virtual Machine [V1, V2]") hyperVGeneration?: HyperVGeneration; @@ -1103,6 +1129,14 @@ model VirtualHardDiskStatus { @doc("Provisioning status of the vhd") provisioningStatus?: VirtualHardDiskStatusProvisioningStatus; + + @added(Versions.v2024_05_01_preview) + @doc("The download status of the virtual hard disk") + downloadStatus?: VirtualHardDiskDownloadStatus; + + @added(Versions.v2024_05_01_preview) + @doc("The upload status of the virtual hard disk") + uploadStatus?: VirtualHardDiskUploadStatus; } @doc("VHD Status provisioning status") @@ -1114,12 +1148,53 @@ model VirtualHardDiskStatusProvisioningStatus { status?: Status; } +@added(Versions.v2024_05_01_preview) +@doc("The download status of the virtual hard disk") +model VirtualHardDiskDownloadStatus { + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB should be referenced as MB." + @doc("The downloaded sized of the virtual hard disk in MB") + downloadedSizeInMB?: int64; +} + +@added(Versions.v2024_05_01_preview) +@doc("The upload status of the virtual hard disk") +model VirtualHardDiskUploadStatus { + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB should be referenced as MB." + @doc("The uploaded sized of the virtual hard disk in MB") + uploadedSizeInMB?: int64; + + @doc("The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]") + status?: Status; +} + @doc("The virtual hard disk resource patch definition.") model VirtualHardDisksUpdateRequest { @doc("Resource tags") tags?: Record; } +@added(Versions.v2024_05_01_preview) +@doc("Request for uploading virtual hard disk.") +model VirtualHardDiskUploadRequest { + @doc("The Azure managed disk SAS URL to upload the virtual hard disk to.") + @secret + azureManagedDiskUploadUrl: string; +} + +@added(Versions.v2024_05_01_preview) +@doc("Response for uploading virtual hard disk.") +model VirtualHardDiskUploadResponse { + @doc("The ARM ID for a Virtual Hard Disk.") + virtualHardDiskId?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/virtualHardDisks"; + } + ]>; + + @doc("The upload status of the virtual hard disk") + uploadStatus?: VirtualHardDiskUploadStatus; +} + @doc("Properties under the virtual machine instance resource") model VirtualMachineInstanceProperties { @doc("HardwareProfile - Specifies the hardware settings for the virtual machine instance.") @@ -1177,6 +1252,12 @@ model VirtualMachineInstancePropertiesHardwareProfile { @doc("Dynamic memory config") dynamicMemoryConfig?: VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "GPU is a short form. It is the correct case." + @added(Versions.v2024_05_01_preview) + @doc("virtualMachineGPUs - list of gpus to be attached to the virtual machine instance") + @extension("x-ms-identifiers", []) + virtualMachineGPUs?: VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU[]; } @doc("Dynamic memory config") @@ -1193,6 +1274,21 @@ model VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig { targetMemoryBuffer?: int32; } +#suppress "@azure-tools/typespec-azure-core/casing-style" "GPU is a short form. It is the correct case." +@added(Versions.v2024_05_01_preview) +@doc("GPU properties - describes the GPU configuration.") +model VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU { + @doc("GPU assignment type") + assignmentType: GpuAssignmentTypeEnum; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("Size of gpu partition in MB for GPU-P") + partitionSizeMB?: int64; + + @doc("Name of the GPU") + gpuName?: string; +} + @doc("NetworkProfile - describes the network configuration the virtual machine instance") model VirtualMachineInstancePropertiesNetworkProfile { @doc("NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance") @@ -1469,6 +1565,12 @@ model HardwareProfileUpdate { #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." @doc("RAM in MB for the virtual machine instance") memoryMB?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "GPU is a short form. It is the correct case." + @added(Versions.v2024_05_01_preview) + @doc("virtualMachineGPUs - updated list of GPUs on the virtual machine instance") + @extension("x-ms-identifiers", []) + virtualMachineGPUs?: VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU[]; } @doc("Storage profile update") diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/Operations_List.json b/specification/azurestackhci/Operations.Management/examples/2024-05-01-preview/Operations_List.json similarity index 99% rename from specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/Operations_List.json rename to specification/azurestackhci/Operations.Management/examples/2024-05-01-preview/Operations_List.json index 4a5ff103d84a..05d612842fcf 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/Operations_List.json +++ b/specification/azurestackhci/Operations.Management/examples/2024-05-01-preview/Operations_List.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2024-02-01-preview" + "api-version": "2024-05-01-preview" }, "responses": { "200": { diff --git a/specification/azurestackhci/Operations.Management/main.tsp b/specification/azurestackhci/Operations.Management/main.tsp index b56ae312dc3e..8139d472a7b0 100644 --- a/specification/azurestackhci/Operations.Management/main.tsp +++ b/specification/azurestackhci/Operations.Management/main.tsp @@ -31,4 +31,11 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_02_01_preview: "2024-02-01-preview", + + /** + * The 2024-05-01-preview API version for internal testing only. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_05_01_preview: "2024-05-01-preview", } diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json index b86d0039c729..6620931c33dd 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json @@ -39,9 +39,6 @@ } }, "tags": [ - { - "name": "Operations" - }, { "name": "GalleryImages" }, @@ -869,42 +866,6 @@ "x-ms-long-running-operation": true } }, - "/providers/Microsoft.AzureStackHCI/operations": { - "get": { - "operationId": "Operations_List", - "tags": [ - "Operations" - ], - "description": "List the operations for the provider", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Azure operation completed successfully.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List the operations for the provider.": { - "$ref": "./examples/Operations_List.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/galleryImages": { "get": { "operationId": "GalleryImages_ListAll", diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/AttestationStatuses_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/AttestationStatuses_Get.json new file mode 100644 index 000000000000..ebfe02b9793e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/AttestationStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/AttestationStatus", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default", + "properties": { + "attestSecureBootEnabled": "Disabled", + "attestationCertValidated": "Invalid", + "bootIntegrityValidated": "Invalid", + "errorMessage": "Attestation token has invalid signature", + "healthStatus": "Unhealthy", + "linuxKernelVersion": "1.0.0.0", + "timestamp": "2023/11/10 9:48" + } + } + } + }, + "operationId": "AttestationStatuses_Get", + "title": "GetAttestationStatus" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..3753c613e8ac --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "imagePath": "C:\\test.vhdx", + "osType": "Linux" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate", + "title": "PutGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Delete.json new file mode 100644 index 000000000000..6620fe7b09c6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Delete", + "title": "DeleteGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Get.json new file mode 100644 index 000000000000..d8af21613962 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_Get", + "title": "GetGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListAll.json new file mode 100644 index 000000000000..42b17730a248 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListAll", + "title": "ListGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..d744379400e8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListByResourceGroup", + "title": "ListGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Update.json new file mode 100644 index 000000000000..49e9c04c3134 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GalleryImages_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "galleryImageName": "test-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Update", + "title": "UpdateGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Create.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Create.json new file mode 100644 index 000000000000..e2c29d92c260 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resource": { + "properties": { + "credentials": { + "password": "", + "username": "tempuser" + }, + "provisioningAction": "install" + } + }, + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Created", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Create", + "title": "CreateGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Delete.json new file mode 100644 index 000000000000..d9f3cb3b5ebe --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GuestAgents_Delete", + "title": "DeleteGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Get.json new file mode 100644 index 000000000000..03d02242c79c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Get", + "title": "GetGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..b67a60f9cf79 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + ] + } + } + }, + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "title": "GuestAgentListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadataGroup_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadataGroup_Get.json new file mode 100644 index 000000000000..bd7ac1fdba37 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadataGroup_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + } + }, + "operationId": "HybridIdentityMetadata_Get", + "title": "GetHybridIdentityMetadata" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..98ed3a357d4e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + ] + } + } + }, + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "title": "HybridIdentityMetadataListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..c6c9cfa1f567 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2" + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "LogicalNetworks_CreateOrUpdate", + "title": "PutLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Delete.json new file mode 100644 index 000000000000..8ab565b35b91 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Delete", + "title": "DeleteLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Get.json new file mode 100644 index 000000000000..b2faecc0a2e6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "LogicalNetworks_Get", + "title": "GetLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListAll.json new file mode 100644 index 000000000000..a41e7ddf2061 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListAll.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListAll", + "title": "ListLogicalNetworkBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..e07599d14080 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_ListByResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListByResourceGroup", + "title": "ListLogicalNetworkByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Update.json new file mode 100644 index 000000000000..2bcb54a19af2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/LogicalNetworks_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "logicalNetworkName": "test-lnet", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Update", + "title": "UpdateLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..32ffbd23cd3a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "name": "test-marketplace-gallery-image", + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "version": { + "name": "1.0.0" + } + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Creating", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "title": "PutMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Delete.json new file mode 100644 index 000000000000..c389d8e04126 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Delete", + "title": "DeleteMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Get.json new file mode 100644 index 000000000000..77ec0c7e19a4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_Get", + "title": "GetMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListAll.json new file mode 100644 index 000000000000..84043b8e1a25 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListAll.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListAll", + "title": "ListMarketplaceGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..086d36275af7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "title": "ListMarketplaceGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Update.json new file mode 100644 index 000000000000..e4bef1e4c84e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/MarketplaceGalleryImages_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "marketplaceGalleryImageName": "test-marketplce-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Update", + "title": "UpdateMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json new file mode 100644 index 000000000000..87662eb83c49 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ] + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "PutNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..05245254fbec --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Delete", + "title": "DeleteNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..1be4f9aaa256 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "NetworkInterfaces_Get", + "title": "GetNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListAll.json new file mode 100644 index 000000000000..6818854cdfbc --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListAll.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListAll", + "title": "ListNetworkInterfaceBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..4327e99db901 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListByResourceGroup", + "title": "ListNetworkInterfaceByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..f5ad9561a250 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkInterfaces_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkInterfaceName": "test-nic", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Update", + "title": "UpdateNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..d86710b167a9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "CreateNetworkSecurityGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Delete.json new file mode 100644 index 000000000000..ee7e041aa01a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_Delete", + "title": "Delete network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Get.json new file mode 100644 index 000000000000..337d569cc85e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg1/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_Get", + "title": "Get network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListAll.json new file mode 100644 index 000000000000..26929e37f992 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg2", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg2/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg2", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListAll", + "title": "List all network security groups" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..8fe04612bbc5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg3", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg3", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "title": "List network security groups in resource group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_UpdateTags.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_UpdateTags.json new file mode 100644 index 000000000000..fe640dd1586b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/NetworkSecurityGroups_UpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_UpdateTags", + "title": "Update network security group tags" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_CreateOrUpdate.json new file mode 100644 index 000000000000..af11401c7a09 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_CreateOrUpdate", + "title": "SecurityRulesCreateOrUpdate" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Delete.json new file mode 100644 index 000000000000..8767216c5e9d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "SecurityRules_Delete", + "title": "SecurityRulesDelete" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Get.json new file mode 100644 index 000000000000..8976a2ee9ac7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_Get", + "title": "Get network security rule in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..c702f1158ace --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + ] + } + } + }, + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "title": "List network security rules in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_CreateOrUpdate.json new file mode 100644 index 000000000000..5634311112cc --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "path": "C:\\container_storage" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "StorageContainers_CreateOrUpdate", + "title": "PutStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Delete.json new file mode 100644 index 000000000000..a241173f505f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Delete", + "title": "DeleteStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Get.json new file mode 100644 index 000000000000..385582d877a7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "StorageContainers_Get", + "title": "GetStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListAll.json new file mode 100644 index 000000000000..0c946ce3464b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListAll.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListAll", + "title": "ListStorageContainerBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListByResourceGroup.json new file mode 100644 index 000000000000..7a4cc6f39984 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListByResourceGroup", + "title": "ListStorageContainerByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Update.json new file mode 100644 index 000000000000..289083fcfe60 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/StorageContainers_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Update", + "title": "UpdateStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json new file mode 100644 index 000000000000..8a1fff2cc916 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "diskSizeGB": 32 + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "PutVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Delete.json new file mode 100644 index 000000000000..a1ccb15ea179 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Delete", + "title": "DeleteVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Get.json new file mode 100644 index 000000000000..7457a6999fe9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "VirtualHardDisks_Get", + "title": "GetVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListAll.json new file mode 100644 index 000000000000..7c4ca9fe919e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListAll", + "title": "ListVirtualHardDiskBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json new file mode 100644 index 000000000000..736075b23852 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListByResourceGroup", + "title": "ListVirtualHardDiskByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Update.json new file mode 100644 index 000000000000..9ab9e513458d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualHardDisks_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "properties": { + "tags": { + "additionalProperties": "sample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Update", + "title": "UpdateVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json new file mode 100644 index 000000000000..bb4511224767 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json new file mode 100644 index 000000000000..6b590098cccf --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGpu" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json new file mode 100644 index 000000000000..c4347703d542 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json new file mode 100644 index 000000000000..b8eaef16b1db --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Succeeded", + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithOsDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json new file mode 100644 index 000000000000..daaf89aa9ba1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster", + "windowsConfiguration": { + "provisionVMConfigAgent": true + } + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithVMConfigAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Delete.json new file mode 100644 index 000000000000..b947401fd488 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Delete", + "title": "DeleteVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Get.json new file mode 100644 index 000000000000..6cb37dc6842c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_Get", + "title": "GetVirtualMachineInstance" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_List.json new file mode 100644 index 000000000000..b2f90d5d05b5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + ] + } + } + }, + "operationId": "VirtualMachineInstances_List", + "title": "ListVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Pause.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Pause.json new file mode 100644 index 000000000000..5cef0e76a571 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Pause.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Pause", + "title": "PauseVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Restart.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Restart.json new file mode 100644 index 000000000000..22341b12d2d3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Restart", + "title": "RestartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Save.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Save.json new file mode 100644 index 000000000000..9570f08f4518 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Save.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Save", + "title": "SaveVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Start.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Start.json new file mode 100644 index 000000000000..50f18ee80b67 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Start", + "title": "StartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Stop.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Stop.json new file mode 100644 index 000000000000..c2385ed7dfdd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Stop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Stop", + "title": "StopVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Update.json new file mode 100644 index 000000000000..c510a6b492fa --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/examples/VirtualMachineInstances_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "properties": { + "properties": { + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ], + "imageReference": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + } + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Update", + "title": "UpdateVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json new file mode 100644 index 000000000000..6299e226ac5d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json @@ -0,0 +1,7146 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-05-01-preview", + "description": "Azure Stack HCI management service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "GalleryImages" + }, + { + "name": "LogicalNetworks" + }, + { + "name": "MarketplaceGalleryImages" + }, + { + "name": "NetworkInterfaces" + }, + { + "name": "NetworkSecurityGroups" + }, + { + "name": "SecurityRules" + }, + { + "name": "StorageContainers" + }, + { + "name": "VirtualHardDisks" + }, + { + "name": "VirtualMachineInstances" + }, + { + "name": "HybridIdentityMetadataGroup" + }, + { + "name": "AttestationStatuses" + }, + { + "name": "GuestAgents" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances": { + "get": { + "operationId": "VirtualMachineInstances_List", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Lists all of the virtual machine instances within the specified parent resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualMachineInstances": { + "$ref": "./examples/VirtualMachineInstances_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default": { + "get": { + "operationId": "VirtualMachineInstances_Get", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Gets a virtual machine instance", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualMachineInstance": { + "$ref": "./examples/VirtualMachineInstances_Get.json" + } + } + }, + "put": { + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualMachineInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "201": { + "description": "Resource 'VirtualMachineInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutVirtualMachineInstanceWithGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithGpu": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json" + }, + "PutVirtualMachineInstanceWithMarketplaceGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithOsDisk": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json" + }, + "PutVirtualMachineInstanceWithVMConfigAgent": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualMachineInstances_Update", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to update a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualMachineInstances_Delete", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to delete a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default": { + "get": { + "operationId": "AttestationStatuses_Get", + "tags": [ + "AttestationStatuses" + ], + "description": "Implements AttestationStatus GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AttestationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAttestationStatus": { + "$ref": "./examples/AttestationStatuses_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents": { + "get": { + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "tags": [ + "GuestAgents" + ], + "description": "Returns the list of GuestAgent of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuestAgentListByVirtualMachineInstances": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default": { + "get": { + "operationId": "GuestAgents_Get", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGuestAgent": { + "$ref": "./examples/GuestAgents_Get.json" + } + } + }, + "put": { + "operationId": "GuestAgents_Create", + "tags": [ + "GuestAgents" + ], + "description": "Create Or Update GuestAgent.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GuestAgent" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GuestAgent' update operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "201": { + "description": "Resource 'GuestAgent' create operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateGuestAgent": { + "$ref": "./examples/GuestAgents_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GuestAgents_Delete", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent DELETE method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteGuestAgent": { + "$ref": "./examples/GuestAgents_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata": { + "get": { + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Returns the list of HybridIdentityMetadata of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadataListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HybridIdentityMetadataListByVirtualMachineInstances": { + "$ref": "./examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default": { + "get": { + "operationId": "HybridIdentityMetadata_Get", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Implements HybridIdentityMetadata GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetHybridIdentityMetadata": { + "$ref": "./examples/HybridIdentityMetadataGroup_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/pause": { + "post": { + "operationId": "VirtualMachineInstances_Pause", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to pause a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PauseVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Pause.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/restart": { + "post": { + "operationId": "VirtualMachineInstances_Restart", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to restart a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RestartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Restart.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/save": { + "post": { + "operationId": "VirtualMachineInstances_Save", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to save a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SaveVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Save.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/start": { + "post": { + "operationId": "VirtualMachineInstances_Start", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to start a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Start.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/stop": { + "post": { + "operationId": "VirtualMachineInstances_Stop", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to stop a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StopVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Stop.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListAll", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageBySubscription": { + "$ref": "./examples/GalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListAll", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkBySubscription": { + "$ref": "./examples/LogicalNetworks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListAll", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageBySubscription": { + "$ref": "./examples/MarketplaceGalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListAll", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceBySubscription": { + "$ref": "./examples/NetworkInterfaces_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListAll", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in a subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all network security groups": { + "$ref": "./examples/NetworkSecurityGroups_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListAll", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerBySubscription": { + "$ref": "./examples/StorageContainers_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListAll", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskBySubscription": { + "$ref": "./examples/VirtualHardDisks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListByResourceGroup", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageByResourceGroup": { + "$ref": "./examples/GalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}": { + "get": { + "operationId": "GalleryImages_Get", + "tags": [ + "GalleryImages" + ], + "description": "Gets a gallery image", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGalleryImage": { + "$ref": "./examples/GalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "GalleryImages_CreateOrUpdate", + "tags": [ + "GalleryImages" + ], + "description": "The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Resource 'GalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutGalleryImage": { + "$ref": "./examples/GalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "GalleryImages_Update", + "tags": [ + "GalleryImages" + ], + "description": "The operation to update a gallery image.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateGalleryImage": { + "$ref": "./examples/GalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GalleryImages_Delete", + "tags": [ + "GalleryImages" + ], + "description": "The operation to delete a gallery image.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteGalleryImage": { + "$ref": "./examples/GalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListByResourceGroup", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkByResourceGroup": { + "$ref": "./examples/LogicalNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}": { + "get": { + "operationId": "LogicalNetworks_Get", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to get a logical network.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "LogicalNetworks_CreateOrUpdate", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to create or update a logical network. Please note some properties can be set only during logical network creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogicalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "201": { + "description": "Resource 'LogicalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogicalNetworks_Update", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to update a logical network.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetworksUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogicalNetworks_Delete", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to delete a logical network.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageByResourceGroup": { + "$ref": "./examples/MarketplaceGalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}": { + "get": { + "operationId": "MarketplaceGalleryImages_Get", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Gets a marketplace gallery image", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MarketplaceGalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "201": { + "description": "Resource 'MarketplaceGalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "MarketplaceGalleryImages_Update", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to update a marketplace gallery image.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MarketplaceGalleryImages_Delete", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to delete a marketplace gallery image.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListByResourceGroup", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceByResourceGroup": { + "$ref": "./examples/NetworkInterfaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}": { + "get": { + "operationId": "NetworkInterfaces_Get", + "tags": [ + "NetworkInterfaces" + ], + "description": "Gets a network interface", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Get.json" + } + } + }, + "put": { + "operationId": "NetworkInterfaces_CreateOrUpdate", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to create or update a network interface. Please note some properties can be set only during network interface creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkInterface' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "201": { + "description": "Resource 'NetworkInterface' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkInterfaces_Update", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to update a network interface.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfaceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkInterfaces_Delete", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to delete a network interface.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in a resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { + "$ref": "./examples/NetworkSecurityGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}": { + "get": { + "operationId": "NetworkSecurityGroups_Get", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets the specified network security group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security group": { + "$ref": "./examples/NetworkSecurityGroups_Get.json" + } + } + }, + "put": { + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Creates or updates a network security group in the specified resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkSecurityGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "201": { + "description": "Resource 'NetworkSecurityGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateNetworkSecurityGroup": { + "$ref": "./examples/NetworkSecurityGroups_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkSecurityGroups_UpdateTags", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Updates a network security group tags.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { + "$ref": "./examples/NetworkSecurityGroups_UpdateTags.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkSecurityGroups_Delete", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Deletes the specified network security group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network security group": { + "$ref": "./examples/NetworkSecurityGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "tags": [ + "SecurityRules" + ], + "description": "Gets all security rules in a Network Security Group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { + "$ref": "./examples/SecurityRules_ListByNetworkSecurityGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "get": { + "operationId": "SecurityRules_Get", + "tags": [ + "SecurityRules" + ], + "description": "Gets the specified security rule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { + "$ref": "./examples/SecurityRules_Get.json" + } + } + }, + "put": { + "operationId": "SecurityRules_CreateOrUpdate", + "tags": [ + "SecurityRules" + ], + "description": "Creates or updates a security rule in the specified resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecurityRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Resource 'SecurityRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecurityRulesCreateOrUpdate": { + "$ref": "./examples/SecurityRules_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecurityRules_Delete", + "tags": [ + "SecurityRules" + ], + "description": "Deletes the specified security rule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecurityRulesDelete": { + "$ref": "./examples/SecurityRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListByResourceGroup", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerByResourceGroup": { + "$ref": "./examples/StorageContainers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}": { + "get": { + "operationId": "StorageContainers_Get", + "tags": [ + "StorageContainers" + ], + "description": "Gets a storage container", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetStorageContainer": { + "$ref": "./examples/StorageContainers_Get.json" + } + } + }, + "put": { + "operationId": "StorageContainers_CreateOrUpdate", + "tags": [ + "StorageContainers" + ], + "description": "The operation to create or update a storage container. Please note some properties can be set only during storage container creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainer" + } + } + ], + "responses": { + "200": { + "description": "Resource 'StorageContainer' update operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "201": { + "description": "Resource 'StorageContainer' create operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutStorageContainer": { + "$ref": "./examples/StorageContainers_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "StorageContainers_Update", + "tags": [ + "StorageContainers" + ], + "description": "The operation to update a storage container.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateStorageContainer": { + "$ref": "./examples/StorageContainers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "StorageContainers_Delete", + "tags": [ + "StorageContainers" + ], + "description": "The operation to delete a storage container.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteStorageContainer": { + "$ref": "./examples/StorageContainers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListByResourceGroup", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskByResourceGroup": { + "$ref": "./examples/VirtualHardDisks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}": { + "get": { + "operationId": "VirtualHardDisks_Get", + "tags": [ + "VirtualHardDisks" + ], + "description": "Gets a virtual hard disk", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Get.json" + } + } + }, + "put": { + "operationId": "VirtualHardDisks_CreateOrUpdate", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualHardDisk' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "201": { + "description": "Resource 'VirtualHardDisk' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualHardDisks_Update", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to update a virtual hard disk.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDiskTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualHardDisks_Delete", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to delete a virtual hard disk.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AttestBootIntegrityPropertyEnum": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + } + }, + "AttestCertPropertyEnum": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + } + }, + "AttestHealthStatusEnum": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + } + }, + "AttestSecureBootPropertyEnum": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + } + }, + "AttestationStatus": { + "type": "object", + "description": "The attestation status of the virtual machine", + "properties": { + "properties": { + "$ref": "#/definitions/AttestationStatusProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AttestationStatusProperties": { + "type": "object", + "description": "Defines the attestation status properties", + "properties": { + "attestSecureBootEnabled": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "default": "Unknown", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + }, + "readOnly": true + }, + "attestationCertValidated": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + }, + "readOnly": true + }, + "bootIntegrityValidated": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + }, + "readOnly": true + }, + "linuxKernelVersion": { + "type": "string", + "description": "kernel version string for Linux VM.", + "readOnly": true + }, + "healthStatus": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "default": "Unknown", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + }, + "readOnly": true + }, + "timestamp": { + "type": "string", + "description": "The time stamp of the last time attestation token is validated by relying party service.", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "The error message of attestation validation and parsing", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "CloudInitDataSource": { + "type": "string", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]", + "enum": [ + "NoCloud", + "Azure" + ], + "x-ms-enum": { + "name": "CloudInitDataSource", + "modelAsString": true, + "values": [ + { + "name": "NoCloud", + "value": "NoCloud", + "description": "NoCloud is used as the datasource" + }, + { + "name": "Azure", + "value": "Azure", + "description": "Azure is used as the datasource" + } + ] + } + }, + "DiskFileFormat": { + "type": "string", + "description": "The format of the actual VHD file [vhd, vhdx]", + "enum": [ + "vhdx", + "vhd" + ], + "x-ms-enum": { + "name": "DiskFileFormat", + "modelAsString": true, + "values": [ + { + "name": "vhdx", + "value": "vhdx", + "description": "VHDX file format" + }, + { + "name": "vhd", + "value": "vhd", + "description": "VHD file format" + } + ] + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationTypes", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationTypes": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true, + "values": [ + { + "name": "CustomLocation", + "value": "CustomLocation", + "description": "Custom extended location type" + } + ] + } + }, + "GalleryDiskImage": { + "type": "object", + "description": "This is the disk image base class.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GalleryImage": { + "type": "object", + "description": "The gallery images resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "GalleryImageIdentifier": { + "type": "object", + "description": "This is the gallery image definition identifier.", + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ] + }, + "GalleryImageListResult": { + "type": "object", + "description": "The response of a GalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GalleryImage items on this page", + "items": { + "$ref": "#/definitions/GalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GalleryImageProperties": { + "type": "object", + "description": "Properties under the gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "imagePath": { + "type": "string", + "format": "password", + "description": "location of the image the gallery image should be created from", + "x-ms-secret": true + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/GalleryImageStatus", + "description": "The observed state of gallery images", + "readOnly": true + }, + "sourceVirtualMachineId": { + "type": "string", + "format": "arm-id", + "description": "Resource ID of the source virtual machine from whose OS disk the gallery image is created.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualMachineInstance" + } + ] + } + } + }, + "required": [ + "osType" + ] + }, + "GalleryImageStatus": { + "type": "object", + "description": "The observed state of gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "GalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/GalleryImageStatusProvisioningStatus", + "description": "provisioning status of the gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/GalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + }, + "x-ms-client-flatten": true + }, + "GalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "GalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "The status of the operation performed on the gallery image", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "GalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in GalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryImageVersion": { + "type": "object", + "description": "Specifies information about the gallery image version that you want to create or update.", + "properties": { + "name": { + "type": "string", + "description": "This is the version of the gallery image." + }, + "properties": { + "$ref": "#/definitions/GalleryImageVersionProperties", + "description": "Describes the properties of a gallery image version.", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageVersionProperties": { + "type": "object", + "description": "Describes the properties of a gallery image version.", + "properties": { + "storageProfile": { + "$ref": "#/definitions/GalleryImageVersionStorageProfile", + "description": "This is the storage profile of a Gallery Image Version." + } + }, + "required": [ + "storageProfile" + ] + }, + "GalleryImageVersionStorageProfile": { + "type": "object", + "description": "This is the storage profile of a Gallery Image Version.", + "properties": { + "osDiskImage": { + "$ref": "#/definitions/GalleryOSDiskImage", + "description": "This is the OS disk image." + } + } + }, + "GalleryImagesUpdateRequest": { + "type": "object", + "description": "The gallery images resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryOSDiskImage": { + "type": "object", + "description": "This is the OS disk image.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GpuAssignmentTypeEnum": { + "type": "string", + "description": "Gpu Assignment types", + "enum": [ + "GpuDDA", + "GpuP" + ], + "x-ms-enum": { + "name": "GpuAssignmentTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "GpuDDA", + "value": "GpuDDA", + "description": "Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA)" + }, + { + "name": "GpuP", + "value": "GpuP", + "description": "Attach Graphics Processing Unit (GPU) using GPU Partitioning" + } + ] + } + }, + "GuestAgent": { + "type": "object", + "description": "Defines the GuestAgent.", + "properties": { + "properties": { + "$ref": "#/definitions/GuestAgentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GuestAgentInstallStatus": { + "type": "object", + "description": "Defines the status of a guest agent installation.", + "properties": { + "vmUuid": { + "type": "string", + "description": "Specifies the VM's unique SMBIOS ID.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StatusTypes", + "description": "The installation status of the hybrid machine agent installation.", + "readOnly": true + }, + "lastStatusChange": { + "type": "string", + "format": "date-time", + "description": "The time of the last status change.", + "readOnly": true + }, + "agentVersion": { + "type": "string", + "description": "The hybrid machine agent full version.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Details about the error state.", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "GuestAgentListResult": { + "type": "object", + "description": "The response of a GuestAgent list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GuestAgent items on this page", + "items": { + "$ref": "#/definitions/GuestAgent" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GuestAgentProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "credentials": { + "$ref": "#/definitions/GuestCredential", + "description": "Username / Password Credentials to provision guest agent." + }, + "provisioningAction": { + "$ref": "#/definitions/ProvisioningAction", + "description": "The guest agent provisioning action." + }, + "status": { + "type": "string", + "description": "The guest agent status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "GuestCredential": { + "type": "object", + "description": "Username / Password Credentials to connect to guest.", + "properties": { + "username": { + "type": "string", + "description": "The username to connect with the guest." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password to connect with the guest.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "HardwareProfileUpdate": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "$ref": "#/definitions/VmSizeEnum", + "description": "VM Size Enum" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + }, + "virtualMachineGPUs": { + "type": "array", + "description": "virtualMachineGPUs - updated list of GPUs on the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU" + }, + "x-ms-identifiers": [] + } + } + }, + "HttpProxyConfiguration": { + "type": "object", + "description": "HTTP Proxy configuration for the VM.", + "properties": { + "httpProxy": { + "type": "string", + "format": "password", + "description": "The HTTP proxy server endpoint to use.", + "x-ms-secret": true + }, + "httpsProxy": { + "type": "string", + "format": "password", + "description": "The HTTPS proxy server endpoint to use.", + "x-ms-secret": true + }, + "noProxy": { + "type": "array", + "description": "The endpoints that should not go through proxy.", + "items": { + "type": "string" + } + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "HybridIdentityMetadata": { + "type": "object", + "description": "Defines the HybridIdentityMetadata.", + "properties": { + "properties": { + "$ref": "#/definitions/HybridIdentityMetadataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true + }, + "HybridIdentityMetadataListResult": { + "type": "object", + "description": "The response of a HybridIdentityMetadata list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HybridIdentityMetadata items on this page", + "items": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HybridIdentityMetadataProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "resourceUid": { + "type": "string", + "description": "The unique identifier for the resource." + }, + "publicKey": { + "type": "string", + "description": "The Public Key." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "HyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true, + "values": [ + { + "name": "V1", + "value": "V1", + "description": "Generation 1 (V1) hypervisor" + }, + { + "name": "V2", + "value": "V2", + "description": "Generation 2 (V2) hypervisor" + } + ] + } + }, + "IPConfiguration": { + "type": "object", + "description": "InterfaceIPConfiguration IPConfiguration in a network interface.", + "properties": { + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "$ref": "#/definitions/IPConfigurationProperties", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration." + } + }, + "x-ms-client-flatten": true + }, + "IPConfigurationProperties": { + "type": "object", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration.", + "properties": { + "gateway": { + "type": "string", + "description": "Gateway for network interface", + "readOnly": true + }, + "prefixLength": { + "type": "string", + "description": "prefixLength for network interface", + "readOnly": true + }, + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress - Private IP address of the IP configuration." + }, + "subnet": { + "$ref": "#/definitions/LogicalNetworkArmReference", + "description": "Subnet - Name of Subnet bound to the IP configuration." + } + } + }, + "IPPool": { + "type": "object", + "description": "Describes IPPool", + "properties": { + "name": { + "type": "string", + "description": "Name of the IP-Pool" + }, + "ipPoolType": { + "$ref": "#/definitions/IPPoolTypeEnum", + "description": "Type of the IP Pool [vm, vippool]" + }, + "start": { + "type": "string", + "description": "Start of the IP address pool" + }, + "end": { + "type": "string", + "description": "End of the IP address pool" + }, + "info": { + "$ref": "#/definitions/IPPoolInfo", + "description": "IPPool info" + } + } + }, + "IPPoolInfo": { + "type": "object", + "description": "IP Pool info", + "properties": { + "used": { + "type": "string", + "description": "Number of IP addresses allocated from the IP Pool", + "readOnly": true + }, + "available": { + "type": "string", + "description": "Number of IP addresses available in the IP Pool", + "readOnly": true + } + } + }, + "IPPoolTypeEnum": { + "type": "string", + "description": "Type of the IP Pool [vm, vippool]", + "enum": [ + "vm", + "vippool" + ], + "x-ms-enum": { + "name": "IPPoolTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "vm", + "value": "vm", + "description": "Virtual Machine IP Pool" + }, + { + "name": "vippool", + "value": "vippool", + "description": "VIP Pool" + } + ] + } + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID of resource identity. The value must be an UUID.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of resource. The value must be an UUID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "modelAsString": false + } + } + } + }, + "ImageArmReference": { + "type": "object", + "description": "The ARM ID for a Gallery Image.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for an image resource used by the virtual machine instance.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/galleryImages" + }, + { + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages" + } + ] + } + } + } + }, + "InstanceViewStatus": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "$ref": "#/definitions/StatusLevelTypes", + "description": "The level code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + }, + "InterfaceDNSSettings": { + "type": "object", + "description": "DNS Settings of the interface", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS server IP Addresses for the interface", + "items": { + "type": "string" + } + } + } + }, + "IpAllocationMethodEnum": { + "type": "string", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'", + "enum": [ + "Dynamic", + "Static" + ], + "x-ms-enum": { + "name": "IpAllocationMethodEnum", + "modelAsString": true, + "values": [ + { + "name": "Dynamic", + "value": "Dynamic", + "description": "Dynamic IP allocation method" + }, + { + "name": "Static", + "value": "Static", + "description": "Static IP allocation method" + } + ] + } + }, + "LogicalNetwork": { + "type": "object", + "description": "The logical network resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "LogicalNetworkArmReference": { + "type": "object", + "description": "The ARM ID for a Logical Network.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Logical Network.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/logicalNetworks" + } + ] + } + } + } + }, + "LogicalNetworkListResult": { + "type": "object", + "description": "The response of a LogicalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogicalNetwork items on this page", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogicalNetworkProperties": { + "type": "object", + "description": "Properties under the logical network resource", + "properties": { + "dhcpOptions": { + "$ref": "#/definitions/LogicalNetworkPropertiesDhcpOptions", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options." + }, + "subnets": { + "type": "array", + "description": "Subnet - list of subnets under the logical network", + "items": { + "$ref": "#/definitions/Subnet" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the logical network.", + "readOnly": true + }, + "vmSwitchName": { + "type": "string", + "description": "name of the network switch to be used for VMs" + }, + "status": { + "$ref": "#/definitions/LogicalNetworkStatus", + "description": "The observed state of logical networks", + "readOnly": true + } + } + }, + "LogicalNetworkPropertiesDhcpOptions": { + "type": "object", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.", + "properties": { + "dnsServers": { + "type": "array", + "description": "The list of DNS servers IP addresses.", + "items": { + "type": "string" + } + } + } + }, + "LogicalNetworkStatus": { + "type": "object", + "description": "The observed state of logical networks", + "properties": { + "errorCode": { + "type": "string", + "description": "LogicalNetwork provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/LogicalNetworkStatusProvisioningStatus", + "description": "Logical network provisioning status" + } + }, + "x-ms-client-flatten": true + }, + "LogicalNetworkStatusProvisioningStatus": { + "type": "object", + "description": "Describes the status of the provisioning.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the logical network" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the logical network [Succeeded, Failed, InProgress]" + } + } + }, + "LogicalNetworksUpdateRequest": { + "type": "object", + "description": "The logical network resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImage": { + "type": "object", + "description": "The marketplace gallery image resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/MarketplaceGalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "MarketplaceGalleryImageListResult": { + "type": "object", + "description": "The response of a MarketplaceGalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MarketplaceGalleryImage items on this page", + "items": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MarketplaceGalleryImageProperties": { + "type": "object", + "description": "Properties under the marketplace gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for marketplace gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the marketplace gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/MarketplaceGalleryImageStatus", + "description": "The observed state of marketplace gallery images", + "readOnly": true + } + }, + "required": [ + "osType" + ] + }, + "MarketplaceGalleryImageStatus": { + "type": "object", + "description": "The observed state of marketplace gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "MarketplaceGalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusProvisioningStatus", + "description": "Provisioning status of marketplace gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + }, + "x-ms-client-flatten": true + }, + "MarketplaceGalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "MarketplaceGalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "Marketplace GalleryImage provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "MarketplaceGalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in MarketplaceGalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImagesUpdateRequest": { + "type": "object", + "description": "The marketplace gallery image resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterface": { + "type": "object", + "description": "The network interface resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "NetworkInterfaceArmReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "NetworkInterfaceListResult": { + "type": "object", + "description": "The response of a NetworkInterface list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkInterface items on this page", + "items": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkInterfaceProperties": { + "type": "object", + "description": "Properties under the network interface resource", + "properties": { + "ipConfigurations": { + "type": "array", + "description": "IPConfigurations - A list of IPConfigurations of the network interface.", + "items": { + "$ref": "#/definitions/IPConfiguration" + }, + "x-ms-identifiers": [] + }, + "macAddress": { + "type": "string", + "description": "MacAddress - The MAC address of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/InterfaceDNSSettings", + "description": "DNS Settings for the interface" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the network interface.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/NetworkInterfaceStatus", + "description": "The observed state of network interfaces", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the network interface." + } + } + }, + "NetworkInterfaceStatus": { + "type": "object", + "description": "The observed state of network interfaces", + "properties": { + "errorCode": { + "type": "string", + "description": "NetworkInterface provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/NetworkInterfaceStatusProvisioningStatus", + "description": "Network interface provisioning status" + } + }, + "x-ms-client-flatten": true + }, + "NetworkInterfaceStatusProvisioningStatus": { + "type": "object", + "description": "Network interface provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the network interface" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the network interface [Succeeded, Failed, InProgress]" + } + } + }, + "NetworkInterfaceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkInterface resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterfacesUpdateRequest": { + "type": "object", + "description": "The network interface resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkProfileUpdate": { + "type": "object", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkSecurityGroup": { + "type": "object", + "description": "NetworkSecurityGroup resource.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkSecurityGroupArmReference": { + "type": "object", + "description": "The ARM ID for a Network Security Group.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Security Group.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkSecurityGroups" + } + ] + } + } + } + }, + "NetworkSecurityGroupListResult": { + "type": "object", + "description": "The response of a NetworkSecurityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkSecurityGroup items on this page", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkSecurityGroupProperties": { + "type": "object", + "description": "Network Security Group resource.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "A collection of references to network interfaces that are currently using this NSG.", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "subnets": { + "type": "array", + "description": "A collection of references to logical networks that are currently using this NSG", + "items": { + "$ref": "#/definitions/LogicalNetworkArmReference" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "The provisioning state of the network security group resource.", + "readOnly": true + } + } + }, + "NetworkSecurityGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkSecurityGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "Operating system type that the gallery image uses [Windows, Linux]", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows operating system" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux operating system" + } + ] + } + }, + "OsProfileUpdate": { + "type": "object", + "description": "OsProfile - describes the update configuration of the operating system", + "properties": { + "computerName": { + "type": "string", + "description": "ComputerName - name of the computer" + }, + "linuxConfiguration": { + "$ref": "#/definitions/OsProfileUpdateLinuxConfiguration", + "description": "Linux configuration properties" + }, + "windowsConfiguration": { + "$ref": "#/definitions/OsProfileUpdateWindowsConfiguration", + "description": "Windows configuration properties" + } + } + }, + "OsProfileUpdateLinuxConfiguration": { + "type": "object", + "description": "OSProfile update linux configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "OsProfileUpdateWindowsConfiguration": { + "type": "object", + "description": "OSProfile update windows configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "PowerStateEnum": { + "type": "string", + "description": "The power state of the virtual machine instance", + "enum": [ + "Deallocated", + "Deallocating", + "Running", + "Starting", + "Stopped", + "Stopping", + "Paused", + "Saved", + "Unknown" + ], + "x-ms-enum": { + "name": "PowerStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Deallocated", + "value": "Deallocated", + "description": "Virtual machine deallocated" + }, + { + "name": "Deallocating", + "value": "Deallocating", + "description": "Virtual machine deallocating" + }, + { + "name": "Running", + "value": "Running", + "description": "Virtual machine running" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Virtual machine starting" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Virtual machine stopped" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Virtual machine stopping" + }, + { + "name": "Paused", + "value": "Paused", + "description": "Virtual machine paused" + }, + { + "name": "Saved", + "value": "Saved", + "description": "Virtual machine Saved," + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Power state of the virtual machine is unknown" + } + ] + } + }, + "ProvisioningAction": { + "type": "string", + "description": "Defines the different types of operations for guest agent.", + "enum": [ + "install", + "uninstall", + "repair" + ], + "x-ms-enum": { + "name": "ProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "install", + "value": "install", + "description": "Install guest agent" + }, + { + "name": "uninstall", + "value": "uninstall", + "description": "Uninstall guest agent" + }, + { + "name": "repair", + "value": "repair", + "description": "Repair guest agent" + } + ] + } + }, + "ProvisioningStateEnum": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "InProgress", + "Accepted", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning has succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning has failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in progress" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Provisioning has been accepted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion of the resource is in progress" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning has been canceled" + } + ] + }, + "readOnly": true + }, + "Route": { + "type": "object", + "description": "Route - Route resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RouteProperties", + "description": "Properties of the route.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - name of the subnet", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "RouteProperties": { + "type": "object", + "description": "RoutePropertiesFormat - Route resource.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + } + } + }, + "RouteTable": { + "type": "object", + "description": "Route table resource.", + "properties": { + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RouteTableProperties", + "description": "Properties of the route table.", + "x-ms-client-flatten": true + } + } + }, + "RouteTableProperties": { + "type": "object", + "description": "RouteTablePropertiesFormat - Route Table resource.", + "properties": { + "routes": { + "type": "array", + "description": "Collection of routes contained within a route table.", + "items": { + "$ref": "#/definitions/Route" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityRule": { + "type": "object", + "description": "Security Rule resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityRuleProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SecurityRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Network traffic is allowed" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Network traffic is denied" + } + ] + } + }, + "SecurityRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true, + "values": [ + { + "name": "Inbound", + "value": "Inbound", + "description": "Rule is evaluated on incoming traffic" + }, + { + "name": "Outbound", + "value": "Outbound", + "description": "Rule is evaluated on outgoing traffic" + } + ] + } + }, + "SecurityRuleListResult": { + "type": "object", + "description": "The response of a SecurityRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecurityRule items on this page", + "items": { + "$ref": "#/definitions/SecurityRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SecurityRuleProperties": { + "type": "object", + "description": "Security rule resource.", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "$ref": "#/definitions/SecurityRuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sourceAddressPrefixes": { + "type": "array", + "description": "The CIDR or source IP ranges.", + "items": { + "type": "string" + } + }, + "destinationAddressPrefixes": { + "type": "array", + "description": "The destination address prefixes. CIDR or destination IP ranges.", + "items": { + "type": "string" + } + }, + "sourcePortRanges": { + "type": "array", + "description": "The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "destinationPortRanges": { + "type": "array", + "description": "The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "access": { + "$ref": "#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityRuleDirection", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the SR", + "readOnly": true + } + }, + "required": [ + "protocol", + "access", + "priority", + "direction" + ] + }, + "SecurityRuleProtocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "*" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true, + "values": [ + { + "name": "Tcp", + "value": "Tcp", + "description": "Transmission Control Protocol" + }, + { + "name": "Udp", + "value": "Udp", + "description": "User Datagram Protocol" + }, + { + "name": "Icmp", + "value": "Icmp", + "description": "Internet Control Message Protocol" + }, + { + "name": "Asterisk", + "value": "*", + "description": "Wildcard rule for all protocols" + } + ] + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "Trusted Launch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential VM security type" + } + ] + } + }, + "SshConfiguration": { + "type": "object", + "description": "SSH configuration for Linux based VMs running on Azure", + "properties": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.", + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "Status": { + "type": "string", + "description": "The status of the operation performed on the resource [Succeeded, Failed, InProgress]", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Operation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Operation failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Operation is in progress" + } + ] + }, + "readOnly": true + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Informational status level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning status level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error status level" + } + ] + } + }, + "StatusTypes": { + "type": "string", + "description": "The installation status of the hybrid machine agent installation.", + "enum": [ + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Installation succeeded" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Installation in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Installation failed" + } + ] + }, + "readOnly": true + }, + "StorageContainer": { + "type": "object", + "description": "The storage container resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageContainerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "StorageContainerArmReference": { + "type": "object", + "description": "The ARM ID for a Storage Container.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Storage Container.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "StorageContainerListResult": { + "type": "object", + "description": "The response of a StorageContainer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The StorageContainer items on this page", + "items": { + "$ref": "#/definitions/StorageContainer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "StorageContainerProperties": { + "type": "object", + "description": "Properties under the storage container resource", + "properties": { + "path": { + "type": "string", + "description": "Path of the storage container on the disk" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the storage container.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StorageContainerStatus", + "description": "The observed state of storage containers", + "readOnly": true + } + }, + "required": [ + "path" + ] + }, + "StorageContainerStatus": { + "type": "object", + "description": "The observed state of storage containers", + "properties": { + "errorCode": { + "type": "string", + "description": "StorageContainer provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "availableSizeMB": { + "type": "integer", + "format": "int64", + "description": "Amount of space available on the disk in MB" + }, + "containerSizeMB": { + "type": "integer", + "format": "int64", + "description": "Total size of the disk in MB" + }, + "provisioningStatus": { + "$ref": "#/definitions/StorageContainerStatusProvisioningStatus", + "description": "Storage container's provisioning status" + } + }, + "x-ms-client-flatten": true + }, + "StorageContainerStatusProvisioningStatus": { + "type": "object", + "description": "Storage container provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the storage container" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the storage container [Succeeded, Failed, InProgress]" + } + } + }, + "StorageContainerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in StorageContainer resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageContainersUpdateRequest": { + "type": "object", + "description": "The storage container resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageProfileUpdate": { + "type": "object", + "description": "Storage profile update", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance for the update call", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + } + } + }, + "Subnet": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "properties": { + "$ref": "#/definitions/SubnetProperties", + "description": "Properties of the subnet.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "SubnetIpConfigurationReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "ID": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "SubnetProperties": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6." + }, + "addressPrefixes": { + "type": "array", + "description": "List of address prefixes for the subnet.", + "items": { + "type": "string" + } + }, + "ipAllocationMethod": { + "$ref": "#/definitions/IpAllocationMethodEnum", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'" + }, + "ipConfigurationReferences": { + "type": "array", + "description": "IPConfigurationReferences - list of IPConfigurationReferences", + "items": { + "$ref": "#/definitions/SubnetIpConfigurationReference" + }, + "x-ms-identifiers": [] + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the logical network." + }, + "routeTable": { + "$ref": "#/definitions/RouteTable", + "description": "Route table resource." + }, + "ipPools": { + "type": "array", + "description": "network associated pool of IP Addresses", + "items": { + "$ref": "#/definitions/IPPool" + }, + "x-ms-identifiers": [] + }, + "vlan": { + "type": "integer", + "format": "int32", + "description": "Vlan to use for the subnet" + } + } + }, + "TagsObject": { + "type": "object", + "description": "Tags object for patch operations.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "The virtual hard disk resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualHardDiskProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "VirtualHardDiskArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Hard Disk.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + } + } + }, + "VirtualHardDiskDownloadStatus": { + "type": "object", + "description": "The download status of the virtual hard disk", + "properties": { + "downloadedSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the virtual hard disk in MB" + } + } + }, + "VirtualHardDiskListResult": { + "type": "object", + "description": "The response of a VirtualHardDisk list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualHardDisk items on this page", + "items": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualHardDiskProperties": { + "type": "object", + "description": "Properties under the virtual hard disk resource", + "properties": { + "blockSizeBytes": { + "type": "integer", + "format": "int32", + "description": "Block size in bytes" + }, + "diskSizeGB": { + "type": "integer", + "format": "int64", + "description": "Size of the disk in GB" + }, + "dynamic": { + "type": "boolean", + "description": "Boolean for enabling dynamic sizing on the virtual hard disk" + }, + "logicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Logical sector in bytes" + }, + "physicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Physical sector in bytes" + }, + "downloadUrl": { + "type": "string", + "format": "password", + "description": "URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.", + "x-ms-secret": true + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "diskFileFormat": { + "$ref": "#/definitions/DiskFileFormat", + "description": "The format of the actual VHD file [vhd, vhdx]" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual hard disk.", + "readOnly": true + }, + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for VHD", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "status": { + "$ref": "#/definitions/VirtualHardDiskStatus", + "description": "The observed state of virtual hard disks", + "readOnly": true + } + } + }, + "VirtualHardDiskStatus": { + "type": "object", + "description": "The observed state of virtual hard disks", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualHardDisk provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualHardDiskStatusProvisioningStatus", + "description": "Provisioning status of the vhd" + }, + "downloadStatus": { + "$ref": "#/definitions/VirtualHardDiskDownloadStatus", + "description": "The download status of the virtual hard disk" + }, + "uploadStatus": { + "$ref": "#/definitions/VirtualHardDiskUploadStatus", + "description": "The upload status of the virtual hard disk" + } + }, + "x-ms-client-flatten": true + }, + "VirtualHardDiskStatusProvisioningStatus": { + "type": "object", + "description": "VHD Status provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual hard disk" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualHardDiskTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in VirtualHardDisk resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualHardDiskUploadRequest": { + "type": "object", + "description": "Request for uploading virtual hard disk.", + "properties": { + "azureManagedDiskUploadUrl": { + "type": "string", + "format": "password", + "description": "The Azure managed disk SAS URL to upload the virtual hard disk to.", + "x-ms-secret": true + } + }, + "required": [ + "azureManagedDiskUploadUrl" + ] + }, + "VirtualHardDiskUploadResponse": { + "type": "object", + "description": "Response for uploading virtual hard disk.", + "properties": { + "virtualHardDiskId": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + }, + "uploadStatus": { + "$ref": "#/definitions/VirtualHardDiskUploadStatus", + "description": "The upload status of the virtual hard disk" + } + } + }, + "VirtualHardDiskUploadStatus": { + "type": "object", + "description": "The upload status of the virtual hard disk", + "properties": { + "uploadedSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The uploaded sized of the virtual hard disk in MB" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualHardDisksUpdateRequest": { + "type": "object", + "description": "The virtual hard disk resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualMachineArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Machine.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Machine.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualMachineInstance" + } + ] + } + } + } + }, + "VirtualMachineConfigAgentInstanceView": { + "type": "object", + "description": "The instance view of the VM Config Agent running on the virtual machine.", + "properties": { + "vmConfigAgentVersion": { + "type": "string", + "description": "The VM Config Agent full version." + }, + "statuses": { + "type": "array", + "description": "The resource status information.", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstance": { + "type": "object", + "description": "The virtual machine instance resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "VirtualMachineInstanceListResult": { + "type": "object", + "description": "The response of a VirtualMachineInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineInstance items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineInstanceProperties": { + "type": "object", + "description": "Properties under the virtual machine instance resource", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfile", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesNetworkProfile", + "description": "NetworkProfile - describes the network configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfile", + "description": "OsProfile - describes the configuration of the operating system and sets login data" + }, + "securityProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfile", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfile", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance" + }, + "httpProxyConfig": { + "$ref": "#/definitions/HttpProxyConfiguration", + "description": "HTTP Proxy configuration for the VM." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "description": "The virtual machine instance view.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/VirtualMachineInstanceStatus", + "description": "The observed state of virtual machine instances", + "readOnly": true + }, + "guestAgentInstallStatus": { + "$ref": "#/definitions/GuestAgentInstallStatus", + "description": "Guest agent install status." + }, + "vmId": { + "type": "string", + "description": "Unique identifier for the vm resource.", + "readOnly": true + }, + "resourceUid": { + "type": "string", + "description": "Unique identifier defined by ARC to identify the guest of the VM." + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfile": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "type": "string", + "description": "Enum of VM Sizes", + "default": "Default", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + }, + "dynamicMemoryConfig": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig", + "description": "Dynamic memory config" + }, + "virtualMachineGPUs": { + "type": "array", + "description": "virtualMachineGPUs - list of gpus to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig": { + "type": "object", + "description": "Dynamic memory config", + "properties": { + "maximumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Maximum memory in MB" + }, + "minimumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Minimum memory in MB" + }, + "targetMemoryBuffer": { + "type": "integer", + "format": "int32", + "description": "Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000." + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU": { + "type": "object", + "description": "GPU properties - describes the GPU configuration.", + "properties": { + "assignmentType": { + "$ref": "#/definitions/GpuAssignmentTypeEnum", + "description": "GPU assignment type" + }, + "partitionSizeMB": { + "type": "integer", + "format": "int64", + "description": "Size of gpu partition in MB for GPU-P" + }, + "gpuName": { + "type": "string", + "description": "Name of the GPU" + } + }, + "required": [ + "assignmentType" + ] + }, + "VirtualMachineInstancePropertiesNetworkProfile": { + "type": "object", + "description": "NetworkProfile - describes the network configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstancePropertiesOsProfile": { + "type": "object", + "description": "OsProfile - describes the configuration of the operating system and sets login data", + "properties": { + "adminPassword": { + "type": "string", + "format": "password", + "description": "AdminPassword - admin password", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "adminUsername": { + "type": "string", + "description": "AdminUsername - admin username" + }, + "computerName": { + "type": "string", + "description": "ComputerName - name of the compute" + }, + "linuxConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileLinuxConfiguration", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance" + }, + "windowsConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileWindowsConfiguration", + "description": "Windows Configuration for the virtual machine instance" + } + } + }, + "VirtualMachineInstancePropertiesOsProfileLinuxConfiguration": { + "type": "object", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "DisablePasswordAuthentication - whether password authentication should be disabled" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesOsProfileWindowsConfiguration": { + "type": "object", + "description": "Windows Configuration for the virtual machine instance", + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Whether to EnableAutomaticUpdates on the machine" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for Windows OS." + }, + "timeZone": { + "type": "string", + "description": "TimeZone for the virtual machine instance" + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfile": { + "type": "object", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance.", + "properties": { + "enableTPM": { + "type": "boolean", + "description": "Enable TPM flag", + "default": false + }, + "uefiSettings": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfileUefiSettings", + "description": "Uefi settings of the virtual machine instance" + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function." + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfileUefiSettings": { + "type": "object", + "description": "Uefi settings - Specifies whether secure boot should be enabled on the virtual machine instance.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine instance.", + "default": false + } + } + }, + "VirtualMachineInstancePropertiesStorageProfile": { + "type": "object", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + }, + "imageReference": { + "$ref": "#/definitions/ImageArmReference", + "description": "Which Image to use for the virtual machine instance", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfileOsDisk", + "description": "VHD to attach as OS disk" + }, + "vmConfigStoragePathId": { + "type": "string", + "format": "arm-id", + "description": "Id of the storage container that hosts the VM configuration file", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "VirtualMachineInstancePropertiesStorageProfileOsDisk": { + "type": "object", + "description": "VHD to attach as OS disk", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux." + } + } + }, + "VirtualMachineInstanceStatus": { + "type": "object", + "description": "The observed state of virtual machine instances", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualMachine provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "powerState": { + "$ref": "#/definitions/PowerStateEnum", + "description": "The power state of the virtual machine instance" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualMachineInstanceStatusProvisioningStatus", + "description": "Provisioning status of the virtual machine instance" + } + }, + "x-ms-client-flatten": true + }, + "VirtualMachineInstanceStatusProvisioningStatus": { + "type": "object", + "description": "Virtual machine instance provisioning status.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual machine instance" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualMachineInstanceUpdateProperties": { + "type": "object", + "description": "Defines the resource properties for the update.", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfileUpdate", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfileUpdate", + "description": "StorageProfile - Specifies the storage settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfileUpdate", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/OsProfileUpdate", + "description": "OsProfile - describes the update configuration of the operating system" + } + } + }, + "VirtualMachineInstanceUpdateRequest": { + "type": "object", + "description": "The virtual machine instance resource patch definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateProperties", + "description": "Defines the resource properties for the update." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource." + } + } + }, + "VirtualMachineInstanceView": { + "type": "object", + "description": "The instance view of a virtual machine.", + "properties": { + "vmAgent": { + "$ref": "#/definitions/VirtualMachineConfigAgentInstanceView", + "description": "The VM Config Agent running on the virtual machine." + } + } + }, + "VmSizeEnum": { + "type": "string", + "description": "VM Sizes", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md index 8b0a92feed18..d6ad26211f5c 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md @@ -29,7 +29,7 @@ title: Microsoft.AzureStackHCI description: Azure Stack HCI management service openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2024-02-01 +tag: package-preview-2024-05-01-preview ``` ## Suppression @@ -39,16 +39,19 @@ directive: - suppress: R3020 from: - stackhcivm.json + - operations.json reason: Microsoft.AzureStackHCI is the correct name for our RP. suppressions: - code: PathResourceProviderNamePascalCase reason: We had already gone to production with "HCI" in our namespace, so changing it to "Hci" now would be disruptive. from: - stackhcivm.json + - operations.json - code: DefinitionsPropertiesNamesCamelCase reason: There is a false positive reporting the two letter acronym ID should be lower camel case. The property is correctly capitalized according to guidance. from: - stackhcivm.json + - operations.json - code: XmsPageableForListCalls reason: XmsPageable not needed for GET calls from: @@ -59,6 +62,16 @@ suppressions: - stackhcivm.json ``` +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-05-01-preview' +input-file: + - preview/2024-05-01-preview/stackhcivm.json + - ../operations/preview/2024-05-01-preview/operations.json +``` + ### Tag: package-preview-2024-02 These settings apply only when `--tag=package-preview-2024-02-01` is specified on the command line. @@ -66,4 +79,5 @@ These settings apply only when `--tag=package-preview-2024-02-01` is specified o ```yaml $(tag) == 'package-preview-2024-02-01' input-file: - preview/2024-02-01-preview/stackhcivm.json -``` + - ../operations/preview/2024-02-01-preview/operations.json +``` \ No newline at end of file diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/Operations_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-05-01-preview/examples/Operations_List.json similarity index 99% rename from specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/Operations_List.json rename to specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-05-01-preview/examples/Operations_List.json index 4a5ff103d84a..05d612842fcf 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/Operations_List.json +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-05-01-preview/examples/Operations_List.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2024-02-01-preview" + "api-version": "2024-05-01-preview" }, "responses": { "200": { diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-05-01-preview/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-05-01-preview/operations.json new file mode 100644 index 000000000000..2a0aa5994056 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-05-01-preview/operations.json @@ -0,0 +1,86 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-05-01-preview", + "description": "Azure Stack HCI management service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.AzureStackHCI/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the operations for the provider.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml index f47703537f08..10fb5145acbc 100644 --- a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml +++ b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml @@ -25,6 +25,86 @@ suppressions: - Model Extension no longer has parameter last_modified_at - Model Extension no longer has parameter last_modified_by - Model Extension no longer has parameter last_modified_by_type + - The 'ArcConnectivityProperties' method 'validate' was deleted or renamed in the current version + - The 'ArcIdentityResponse' method 'validate' was deleted or renamed in the current version + - The 'ArcSetting' method 'validate' was deleted or renamed in the current version + - The 'ArcSettingList' method 'validate' was deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsOperations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ArcSettingsPatch' method 'validate' was deleted or renamed in the current version + - The 'Cluster' method 'validate' was deleted or renamed in the current version + - The 'ClusterDesiredProperties' method 'validate' was deleted or renamed in the current version + - The 'ClusterIdentityResponse' method 'validate' was deleted or renamed in the current version + - The 'ClusterList' method 'validate' was deleted or renamed in the current version + - The 'ClusterNode' method 'validate' was deleted or renamed in the current version + - The 'ClusterPatch' method 'validate' was deleted or renamed in the current version + - The 'ClusterReportedProperties' method 'validate' was deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ClustersOperations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ErrorAdditionalInfo' method 'validate' was deleted or renamed in the current version + - The 'ErrorDetail' method 'validate' was deleted or renamed in the current version + - The 'ErrorResponse' method 'validate' was deleted or renamed in the current version + - The 'Extension' method 'validate' was deleted or renamed in the current version + - The 'ExtensionList' method 'validate' was deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'ExtensionsOperations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operation' method 'validate' was deleted or renamed in the current version + - The 'OperationDisplay' method 'validate' was deleted or renamed in the current version + - The 'OperationListResult' method 'validate' was deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'client' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'config' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'deserializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'Operations' method '__init__' had its parameter 'serializer' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'PasswordCredential' method 'validate' was deleted or renamed in the current version + - The 'PerNodeExtensionState' method 'validate' was deleted or renamed in the current version + - The 'PerNodeState' method 'validate' was deleted or renamed in the current version + - The 'ProxyResource' method 'validate' was deleted or renamed in the current version + - The 'RawCertificateData' method 'validate' was deleted or renamed in the current version + - The 'Resource' method 'validate' was deleted or renamed in the current version + - The 'TrackedResource' method 'validate' was deleted or renamed in the current version + - The 'UploadCertificateRequest' method 'validate' was deleted or renamed in the current version + - The model or publicly exposed class 'ArcSetting' had its instance variable 'created_at' deleted or renamed in the current version + - The model or publicly exposed class 'ArcSetting' had its instance variable 'created_by' deleted or renamed in the current version + - The model or publicly exposed class 'ArcSetting' had its instance variable 'created_by_type' deleted or renamed in the current version + - The model or publicly exposed class 'ArcSetting' had its instance variable 'last_modified_at' deleted or renamed in the current version + - The model or publicly exposed class 'ArcSetting' had its instance variable 'last_modified_by' deleted or renamed in the current version + - The model or publicly exposed class 'ArcSetting' had its instance variable 'last_modified_by_type' deleted or renamed in the current version + - The model or publicly exposed class 'Cluster' had its instance variable 'created_at' deleted or renamed in the current version + - The model or publicly exposed class 'Cluster' had its instance variable 'created_by' deleted or renamed in the current version + - The model or publicly exposed class 'Cluster' had its instance variable 'created_by_type' deleted or renamed in the current version + - The model or publicly exposed class 'Cluster' had its instance variable 'last_modified_at' deleted or renamed in the current version + - The model or publicly exposed class 'Cluster' had its instance variable 'last_modified_by' deleted or renamed in the current version + - The model or publicly exposed class 'Cluster' had its instance variable 'last_modified_by_type' deleted or renamed in the current version + - The model or publicly exposed class 'Extension' had its instance variable 'created_at' deleted or renamed in the current version + - The model or publicly exposed class 'Extension' had its instance variable 'created_by' deleted or renamed in the current version + - The model or publicly exposed class 'Extension' had its instance variable 'created_by_type' deleted or renamed in the current version + - The model or publicly exposed class 'Extension' had its instance variable 'last_modified_at' deleted or renamed in the current version + - The model or publicly exposed class 'Extension' had its instance variable 'last_modified_by' deleted or renamed in the current version + - The model or publicly exposed class 'Extension' had its instance variable 'last_modified_by_type' deleted or renamed in the current version + - The publicly exposed function 'patch_sdk' was deleted or renamed in the current version + - The publicly exposed function 'patch_sdk' was deleted or renamed in the current version azure-sdk-for-js: - package: '@azure/arm-azurestackhci' @@ -49,4 +129,4 @@ suppressions: - Interface Extension no longer has parameter lastModifiedBy - Interface Extension no longer has parameter lastModifiedByType - Operation Extensions.beginUpdate has a new signature - - Operation Extensions.beginUpdateAndWait has a new signature \ No newline at end of file + - Operation Extensions.beginUpdateAndWait has a new signature From e78b8c3ccdf8418959b7419b39fd5279ea07dfe8 Mon Sep 17 00:00:00 2001 From: Bidisha Chakraborty <29803402+bidisha-c@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:32:16 -0700 Subject: [PATCH 20/30] Typespec for Analyze-Documents (#29979) * Typespec for AnalyzeDocuments * Generated swagger * Update namigs * small change * typo * Fix response * typo * add to readme * compile tsv * fix tsp sdk * small update * Remove older examples * Correct readme merge conflict * Minor corrections based off errrors * minor change in documentation --------- Co-authored-by: Bidisha Chakraborty Co-authored-by: Aurgho Bhattacharjee --- .../Language.AnalyzeDocuments/client.tsp | 602 +++ ...eDocumentsJobStatusTaskStatusRequest.json} | 16 +- ...fulAnalyzeDocumentsJobsCancelRequest.json} | 2 + ...nalyzeDocumentsJobsTaskSubmitRequest.json} | 8 +- .../Language.AnalyzeDocuments/main.tsp | 92 + .../models/common.models.tsp | 904 ++++ .../models/pii.entity.recognition.tsp | 631 +++ .../models/summarization.tsp | 167 + .../Language.AnalyzeDocuments/tspconfig.yaml | 22 + .../2023-11-15-preview/analyzedocuments.json | 3688 +++++++++++++---- ...zeDocumentsJobStatusTaskStatusRequest.json | 61 + ...sfulAnalyzeDocumentsJobsCancelRequest.json | 17 + ...AnalyzeDocumentsJobsTaskSubmitRequest.json | 50 + .../data-plane/Language/readme.md | 2 +- 14 files changed, 5388 insertions(+), 874 deletions(-) create mode 100644 specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp rename specification/cognitiveservices/{data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskResult.json => Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json} (75%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json => Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json} (78%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskSubmit.json => Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json} (81%) create mode 100644 specification/cognitiveservices/Language.AnalyzeDocuments/main.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeDocuments/models/common.models.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeDocuments/models/pii.entity.recognition.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeDocuments/models/summarization.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeDocuments/tspconfig.yaml create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsCancelRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json diff --git a/specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp b/specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp new file mode 100644 index 000000000000..e66bbddbca35 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp @@ -0,0 +1,602 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Language.AnalyzeDocuments; +using Azure.ClientGenerator.Core; + +namespace Language.AnalyzeTextClientCustomizations; + +@@clientName(Tasks, "DocumentActions", "csharp"); +@@clientName(State, "DocumentActionState", "csharp"); +@@clientName(Error, "AnalyzeDocumentsError", "csharp"); + +@@clientName(Entity, "NamedEntity", "csharp"); + +@@clientName(JobState.createdDateTime, "CreatedAt", "csharp"); + +@@clientName(JobState.expirationDateTime, "ExpiresOn", "csharp"); + +@@clientName(JobState.lastUpdatedDateTime, "LastUpdatedAt", "csharp"); + +@@clientName(ErrorCode, "AnalyzeDocumentsErrorCode", "csharp"); + +@@clientName(WarningCodeValue, "WarningCode", "csharp"); + +@@clientName(PiiCategoriesExclude.ABARoutingNumber, + "AbaRoutingNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ARNationalIdentityNumber, + "ArNationalIdentityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.AUBankAccountNumber, + "AuBankAccountNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.AUDriversLicenseNumber, + "AuDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.AUMedicalAccountNumber, + "AuMedicalAccountNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.AUPassportNumber, + "AuPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.AUTaxFileNumber, "AuTaxFileNumber", "csharp"); +@@clientName(PiiCategoriesExclude.AUBusinessNumber, + "AuBusinessNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.AUCompanyNumber, "AuCompanyNumber", "csharp"); +@@clientName(PiiCategoriesExclude.ATIdentityCard, "AtIdentityCard", "csharp"); +@@clientName(PiiCategoriesExclude.ATTaxIdentificationNumber, + "AtTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ATValueAddedTaxNumber, + "AtValueAddedTaxNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.AzureDocumentDBAuthKey, + "AzureDocumentDbauthKey", + "csharp" +); +@@clientName(PiiCategoriesExclude.AzureIAASDatabaseConnectionAndSQLString, + "AzureIaasDatabaseConnectionAndSqlString", + "csharp" +); +@@clientName(PiiCategoriesExclude.AzureSAS, "AzureSas", "csharp"); +@@clientName(PiiCategoriesExclude.BENationalNumber, + "BeNationalNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.BENationalNumberV2, + "BeNationalNumberV2", + "csharp" +); +@@clientName(PiiCategoriesExclude.BEValueAddedTaxNumber, + "BeValueAddedTaxNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.BRCPFNumber, "BrCpfNumber", "csharp"); +@@clientName(PiiCategoriesExclude.BRLegalEntityNumber, + "BrLegalEntityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.BRNationalIDRG, "BrNationalIdRg", "csharp"); +@@clientName(PiiCategoriesExclude.BGUniformCivilNumber, + "BgUniformCivilNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CABankAccountNumber, + "CaBankAccountNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CADriversLicenseNumber, + "CaDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CAHealthServiceNumber, + "CaHealthServiceNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CAPassportNumber, + "CaPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CAPersonalHealthIdentification, + "CaPersonalHealthIdentification", + "csharp" +); +@@clientName(PiiCategoriesExclude.CASocialInsuranceNumber, + "CaSocialInsuranceNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CLIdentityCardNumber, + "ClIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CNResidentIdentityCardNumber, + "CnResidentIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HRIdentityCardNumber, + "HrIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HRNationalIDNumber, + "HrNationalIdNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HRPersonalIdentificationNumber, + "HrPersonalIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HRPersonalIdentificationOIBNumberV2, + "HrPersonalIdentificationOIBNumberV2", + "csharp" +); +@@clientName(PiiCategoriesExclude.CYIdentityCard, "CyIdentityCard", "csharp"); +@@clientName(PiiCategoriesExclude.CYTaxIdentificationNumber, + "CyTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CZPersonalIdentityNumber, + "CzPersonalIdentityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.CZPersonalIdentityV2, + "CzPersonalIdentityV2", + "csharp" +); +@@clientName(PiiCategoriesExclude.DKPersonalIdentificationNumber, + "DkPersonalIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.DKPersonalIdentificationV2, + "DkPersonalIdentificationV2", + "csharp" +); +@@clientName(PiiCategoriesExclude.EEPersonalIdentificationCode, + "EePersonalIdentificationCode", + "csharp" +); +@@clientName(PiiCategoriesExclude.EUDebitCardNumber, + "EuDebitCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.EUDriversLicenseNumber, + "EuDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.EUGPSCoordinates, + "EuGpsCoordinates", + "csharp" +); +@@clientName(PiiCategoriesExclude.EUNationalIdentificationNumber, + "EuNationalIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.EUPassportNumber, + "EuPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.EUSocialSecurityNumber, + "EuSocialSecurityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.EUTaxIdentificationNumber, + "EuTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FIEuropeanHealthNumber, + "FiEuropeanHealthNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FINationalID, "FiNationalId", "csharp"); +@@clientName(PiiCategoriesExclude.FINationalIDV2, "FiNationalIdV2", "csharp"); +@@clientName(PiiCategoriesExclude.FIPassportNumber, + "FiPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FRDriversLicenseNumber, + "FrDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FRHealthInsuranceNumber, + "FrHealthInsuranceNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FRNationalID, "FrNationalId", "csharp"); +@@clientName(PiiCategoriesExclude.FRPassportNumber, + "FrPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FRSocialSecurityNumber, + "FrSocialSecurityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FRTaxIdentificationNumber, + "FrTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.FRValueAddedTaxNumber, + "FrValueAddedTaxNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.DEDriversLicenseNumber, + "DeDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.DEPassportNumber, + "DePassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.DEIdentityCardNumber, + "DeIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.DETaxIdentificationNumber, + "DeTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.DEValueAddedNumber, + "DeValueAddedNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.GRNationalIDCard, + "GrNationalIdCard", + "csharp" +); +@@clientName(PiiCategoriesExclude.GRNationalIDV2, "GrNationalIdV2", "csharp"); +@@clientName(PiiCategoriesExclude.GRTaxIdentificationNumber, + "GrTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HKIdentityCardNumber, + "HkIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HUValueAddedNumber, + "HuValueAddedNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HUPersonalIdentificationNumber, + "HuPersonalIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.HUTaxIdentificationNumber, + "HuTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.INPermanentAccount, + "InPermanentAccount", + "csharp" +); +@@clientName(PiiCategoriesExclude.INUniqueIdentificationNumber, + "InUniqueIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.IDIdentityCardNumber, + "IdIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.IEPersonalPublicServiceNumber, + "IePersonalPublicServiceNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.IEPersonalPublicServiceNumberV2, + "IePersonalPublicServiceNumberV2", + "csharp" +); +@@clientName(PiiCategoriesExclude.ILBankAccountNumber, + "IlBankAccountNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ILNationalID, "IlNationalId", "csharp"); +@@clientName(PiiCategoriesExclude.ITDriversLicenseNumber, + "ItDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ITFiscalCode, "ItFiscalCode", "csharp"); +@@clientName(PiiCategoriesExclude.ITValueAddedTaxNumber, + "ItValueAddedTaxNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPBankAccountNumber, + "JpBankAccountNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPDriversLicenseNumber, + "JpDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPPassportNumber, + "JpPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPResidentRegistrationNumber, + "JpResidentRegistrationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPSocialInsuranceNumber, + "JpSocialInsuranceNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPMyNumberCorporate, + "JpMyNumberCorporate", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPMyNumberPersonal, + "JpMyNumberPersonal", + "csharp" +); +@@clientName(PiiCategoriesExclude.JPResidenceCardNumber, + "JpResidenceCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.LVPersonalCode, "LvPersonalCode", "csharp"); +@@clientName(PiiCategoriesExclude.LTPersonalCode, "LtPersonalCode", "csharp"); +@@clientName(PiiCategoriesExclude.LUNationalIdentificationNumberNatural, + "LuNationalIdentificationNumberNatural", + "csharp" +); +@@clientName(PiiCategoriesExclude.LUNationalIdentificationNumberNonNatural, + "LuNationalIdentificationNumberNonNatural", + "csharp" +); +@@clientName(PiiCategoriesExclude.MYIdentityCardNumber, + "MyIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.MTIdentityCardNumber, + "MtIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.MTTaxIDNumber, "MtTaxIdNumber", "csharp"); +@@clientName(PiiCategoriesExclude.NLCitizensServiceNumber, + "NlCitizensServiceNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NLCitizensServiceNumberV2, + "NlCitizensServiceNumberV2", + "csharp" +); +@@clientName(PiiCategoriesExclude.NLTaxIdentificationNumber, + "NlTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NLValueAddedTaxNumber, + "NlValueAddedTaxNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NZBankAccountNumber, + "NzBankAccountNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NZDriversLicenseNumber, + "NzDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NZInlandRevenueNumber, + "NzInlandRevenueNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NZMinistryOfHealthNumber, + "NzMinistryOfHealthNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NZSocialWelfareNumber, + "NzSocialWelfareNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.NOIdentityNumber, + "NoIdentityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.PHUnifiedMultiPurposeIDNumber, + "PhUnifiedMultiPurposeIdNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.PLIdentityCard, "PlIdentityCard", "csharp"); +@@clientName(PiiCategoriesExclude.PLNationalID, "PlNationalId", "csharp"); +@@clientName(PiiCategoriesExclude.PLNationalIDV2, "PlNationalIdV2", "csharp"); +@@clientName(PiiCategoriesExclude.PLPassportNumber, + "PlPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.PLTaxIdentificationNumber, + "PlTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.PLREGONNumber, "PlRegonNumber", "csharp"); +@@clientName(PiiCategoriesExclude.PTCitizenCardNumber, + "PtCitizenCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.PTCitizenCardNumberV2, + "PtCitizenCardNumberV2", + "csharp" +); +@@clientName(PiiCategoriesExclude.PTTaxIdentificationNumber, + "PtTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ROPersonalNumericalCode, + "RoPersonalNumericalCode", + "csharp" +); +@@clientName(PiiCategoriesExclude.RUPassportNumberDomestic, + "RuPassportNumberDomestic", + "csharp" +); +@@clientName(PiiCategoriesExclude.RUPassportNumberInternational, + "RuPassportNumberInternational", + "csharp" +); +@@clientName(PiiCategoriesExclude.SANationalID, "SaNationalId", "csharp"); +@@clientName(PiiCategoriesExclude.SGNationalRegistrationIdentityCardNumber, + "SgNationalRegistrationIdentityCardNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.SKPersonalNumber, + "SkPersonalNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.SITaxIdentificationNumber, + "SiTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.SIUniqueMasterCitizenNumber, + "SiUniqueMasterCitizenNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ZAIdentificationNumber, + "ZaIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.KRResidentRegistrationNumber, + "KrResidentRegistrationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ESDNI, "EsDni", "csharp"); +@@clientName(PiiCategoriesExclude.ESSocialSecurityNumber, + "EsSocialSecurityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.ESTaxIdentificationNumber, + "EsTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.SQLServerConnectionString, + "SqlServerConnectionString", + "csharp" +); +@@clientName(PiiCategoriesExclude.SENationalID, "SeNationalId", "csharp"); +@@clientName(PiiCategoriesExclude.SENationalIDV2, "SeNationalIdV2", "csharp"); +@@clientName(PiiCategoriesExclude.SEPassportNumber, + "SePassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.SETaxIdentificationNumber, + "SeTaxIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.SWIFTCode, "SwiftCode", "csharp"); +@@clientName(PiiCategoriesExclude.CHSocialSecurityNumber, + "ChSocialSecurityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.TWNationalID, "TwNationalId", "csharp"); +@@clientName(PiiCategoriesExclude.TWPassportNumber, + "TwPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.TWResidentCertificate, + "TwResidentCertificate", + "csharp" +); +@@clientName(PiiCategoriesExclude.THPopulationIdentificationCode, + "ThPopulationIdentificationCode", + "csharp" +); +@@clientName(PiiCategoriesExclude.TRNationalIdentificationNumber, + "TrNationalIdentificationNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.UKDriversLicenseNumber, + "UkDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.UKElectoralRollNumber, + "UkElectoralRollNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.UKNationalHealthNumber, + "UkNationalHealthNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.UKNationalInsuranceNumber, + "UkNationalInsuranceNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.UKUniqueTaxpayerNumber, + "UkUniqueTaxpayerNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.USUKPassportNumber, + "UsUkPassportNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.USBankAccountNumber, + "UsBankAccountNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.USDriversLicenseNumber, + "UsDriversLicenseNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.USIndividualTaxpayerIdentification, + "UsIndividualTaxpayerIdentification", + "csharp" +); +@@clientName(PiiCategoriesExclude.USSocialSecurityNumber, + "UsSocialSecurityNumber", + "csharp" +); +@@clientName(PiiCategoriesExclude.UAPassportNumberDomestic, + "UaPassportNumberDomestic", + "csharp" +); +@@clientName(PiiCategoriesExclude.UAPassportNumberInternational, + "UaPassportNumberInternational", + "csharp" +); + +@@clientName(MultiLanguageAnalysisInput, + "MultiLanguageDocumentInput", + "csharp" +); + +@@clientName(PiiTaskParameters, "PiiActionContent", "csharp"); + +@@clientName(AnalyzeDocumentsLROTask, + "AnalyzeDocumentsOperationAction", + "csharp" +); +@@clientName(AnalyzeDocumentsLROTask.taskName, "Name", "csharp"); + +@@clientName(AnalyzeDocumentsLROTaskKind, + "AnalyzeDocumentsOperationActionKind", + "csharp" +); + +@@clientName(AbstractiveSummarizationLROTask, + "AbstractiveSummarizationOperationAction", + "csharp" +); +@@clientName(AbstractiveSummarizationLROTask.parameters, + "ActionContent", + "csharp" +); +@@clientName(AbstractiveSummarizationTaskParameters, + "AbstractiveSummarizationActionContent", + "csharp" +); + +@@clientName(ExtractiveSummarizationLROTask, + "ExtractiveSummarizationOperationAction", + "csharp" +); +@@clientName(ExtractiveSummarizationLROTask.parameters, + "ActionContent", + "csharp" +); +@@clientName(ExtractiveSummarizationTaskParameters, + "ExtractiveSummarizationActionContent", + "csharp" +); diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskResult.json b/specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json similarity index 75% rename from specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskResult.json rename to specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json index e49738947858..ec80f4e88385 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskResult.json +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json @@ -1,4 +1,6 @@ { + "operationId": "AnalyzeDocumentsJobStatus", + "title": "SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", "api-version": "2023-11-15-preview", @@ -9,17 +11,17 @@ "200": { "headers": {}, "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redact PII Example", + "createdDateTime": "2023-12-30T15:00:45Z", + "displayName": "Extracting Location & US Region", "expirationDateTime": "2020-10-03T15:01:03Z", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "lastUpdatedDateTime": "2023-12-30T15:01:03Z", "status": "succeeded", "tasks": { - "completed": 1, + "completed": 2, "failed": 0, "inProgress": 0, - "total": 1, + "total": 2, "items": [ { "kind": "PiiEntityRecognitionLROResults", @@ -35,11 +37,11 @@ }, "target": [ { - "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545_PiiEntityRecognition_1_document.txt", + "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545/PiiEntityRecognition/1/document.txt", "kind": "AzureBlob" }, { - "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545_PiiEntityRecognition_1.json", + "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545/PiiEntityRecognition/1/document.json", "kind": "AzureBlob" } ], diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json similarity index 78% rename from specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json rename to specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json index 74a03a34a42a..9731ac566fc4 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json @@ -1,4 +1,6 @@ { + "operationId": "AnalyzeDocumentsCancelJob", + "title": "SuccessfulAnalyzeDocumentsJobsCancelRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", "api-version": "2023-11-15-preview", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskSubmit.json b/specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskSubmit.json rename to specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json index 8223a8a81c3d..44d556929d7d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzedocuments/SuccessfulPiiTaskSubmit.json +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/examples/2023-11-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json @@ -1,4 +1,6 @@ { + "operationId": "AnalyzeDocumentsSubmitJob", + "title": "SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", "api-version": "2023-11-15-preview", @@ -28,7 +30,11 @@ "kind": "PiiEntityRecognition", "taskName": "Redact PII Task 1", "parameters": { - "redactionCharacter": "-" + "redactionCharacter": "-", + "piiCategories": [ + "Person", + "Organization" + ] } } ] diff --git a/specification/cognitiveservices/Language.AnalyzeDocuments/main.tsp b/specification/cognitiveservices/Language.AnalyzeDocuments/main.tsp new file mode 100644 index 000000000000..d4c8f187f1cc --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/main.tsp @@ -0,0 +1,92 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; +import "./models/common.models.tsp"; +import "./models/pii.entity.recognition.tsp"; +import "./models/summarization.tsp"; + +using Azure.ClientGenerator.Core; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +/** The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. + * The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. + * Further documentation can be found in https://docs.microsoft.com/azure/cognitive-services/language-service/overview.0 */ +@useAuth( + TypeSpec.Http.ApiKeyAuth< + TypeSpec.Http.ApiKeyLocation.header, + "Ocp-Apim-Subscription-Key" + > +) +@service({ + title: "Microsoft Cognitive Language Service - Document Analysis", +}) +@server( + "{Endpoint}/language", + "Single server endpoint", + { + /** Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). */ + Endpoint: string, + } +) +@versioned(Versions) +namespace Language.AnalyzeDocuments; + +/** Analyze Documents Service Versions */ +enum Versions { + /** Version 2023-11-15-preview */ + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_11_15_preview: "2023-11-15-preview", +} + +alias ServiceTraits = NoRepeatableRequests & + NoConditionalRequests & + NoClientRequestId; + +alias languageOperations = ResourceOperations; + +/** Get the status of a document analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task. */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@summary("Get analysis status and results") +op analyzeDocumentsJobStatus is languageOperations.ResourceRead< + AnalyzeDocumentsJobState, + AnalyzeDocumentsJobQueryParameters +>; + +/** Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@route("/analyze-documents/jobs") +@pollingOperation(analyzeDocumentsJobStatus) +op analyzeDocumentsSubmitJob is Foundations.LongRunningOperation< + { + /** The input for the analyze documents operation. */ + @bodyRoot + @clientName("AnalyzeDocumentOperationInput", "csharp") + body: AnalyzeDocumentJobsInput; + }, + AcceptedResponse, + {}, + ErrorResponse +>; + +/** Cancel a long-running Text Analysis job. */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@summary("Cancel a long-running Text Analysis job.") +@pollingOperation(analyzeDocumentsJobStatus) +@route("/analyze-documents/jobs/{jobId}:cancel") +@post +op analyzeDocumentsCancelJob is Foundations.LongRunningOperation< + { + /** The job ID to cancel. */ + @path + jobId: uuid; + }, + AcceptedResponse, + {}, + ErrorResponse +>; diff --git a/specification/cognitiveservices/Language.AnalyzeDocuments/models/common.models.tsp b/specification/cognitiveservices/Language.AnalyzeDocuments/models/common.models.tsp new file mode 100644 index 000000000000..7dd84ce8f2fa --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/models/common.models.tsp @@ -0,0 +1,904 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Language.AnalyzeDocuments; + +/** These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Model types must use PascalCase" +model AADToken + is OAuth2Auth<[ + { + type: OAuth2FlowType.implicit; + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; + scopes: ["https://cognitiveservices.azure.com/.default"]; + } + ]>; + +/** The kind of the long running analyze documents tasks supported. */ +union AnalyzeDocumentsLROTaskKind { + string, + + /** PII entity recognition task */ + PiiEntityRecognition: "PiiEntityRecognition", + + /** Extractive summarization task */ + ExtractiveSummarization: "ExtractiveSummarization", + + /** Abstractive summarization task */ + AbstractiveSummarization: "AbstractiveSummarization", +} + +/** The kind of the response object returned by the analyze-documents long running task. */ +union AnalyzeDocumentsLROResultsKind { + string, + + /** PII entity recognition LRO results */ + PiiEntityRecognitionLROResults: "PiiEntityRecognitionLROResults", + + /** Extractive summarization LRO results */ + ExtractiveSummarizationLROResults: "ExtractiveSummarizationLROResults", + + /** Abstractive summarization LRO results */ + AbstractiveSummarizationLROResults: "AbstractiveSummarizationLROResults", +} + +/** Collection of input documents to be analyzed by the service. */ +model MultiLanguageAnalysisInput { + /** The input documents to be analyzed. */ + documents?: Array; +} + +/** The long running task to be performed by the service on the input documents. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +@discriminator("kind") +model AnalyzeDocumentsLROTask is TaskIdentifier { + /** The kind of task to perform. */ + kind: AnalyzeDocumentsLROTaskKind; +} + +/** The input object for the analyze documents LRO. */ +model AnalyzeDocumentJobsInput { + /** Name for the task. */ + displayName?: string; + + /** Contains the input to be analyzed. */ + analysisInput: MultiLanguageAnalysisInput; + + /** List of tasks to be performed as part of the LRO. */ + tasks: Array; + + /** Default language to use for records. */ + defaultLanguage?: string; +} + +/** The input object for the prebuilt/default result. */ +model AnalyzeDocumentsPreBuiltResult { + /** Errors by document id. */ + errors: Array; + + /** if showStats=true was specified in the request this field will contain information about the request payload. */ + statistics?: RequestStatistics; + + /** This field indicates which model is used for analysis. */ + modelVersion: string; +} + +/** Defines the detected language for the document. */ +model DocumentDetectedLanguage { + /** If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document. */ + detectedLanguage?: DetectedLanguage; +} + +/** Contains the details of the detected language for the text. */ +model DetectedLanguage { + /** Long name of a detected language (e.g. English, French). */ + name: string; + + /** A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr). */ + iso6391Name: string; + + /** A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. */ + confidenceScore: float64; + + /** Identifies the script of the input document. */ + script?: ScriptKind; + + /** Identifies the script of the input document. */ + scriptCode?: ScriptCode; +} + +/** The script of the text. */ +@added(Versions.v2023_11_15_preview) +union ScriptKind { + string, + + /** Script name for the Arabic script. */ + Arabic: "Arabic", + + /** Script name for the Armenian script. */ + Armenian: "Armenian", + + /** Script name for the Bangla script. */ + Bangla: "Bangla", + + /** Script name for the UnifiedCanadianAboriginalSyllabics script. */ + UnifiedCanadianAboriginalSyllabics: "UnifiedCanadianAboriginalSyllabics", + + /** Script name for the Cyrillic script. */ + Cyrillic: "Cyrillic", + + /** Script name for the Devanagari script. */ + Devanagari: "Devanagari", + + /** Script name for the Ethiopic script. */ + Ethiopic: "Ethiopic", + + /** Script name for the Georgian script. */ + Georgian: "Georgian", + + /** Script name for the Greek script. */ + Greek: "Greek", + + /** Script name for the Gujarati script. */ + Gujarati: "Gujarati", + + /** Script name for the Gurmukhi script. */ + Gurmukhi: "Gurmukhi", + + /** Script name for the Hangul script. */ + Hangul: "Hangul", + + /** Script name for the HanSimplified script. */ + HanSimplified: "HanSimplified", + + /** Script name for the HanTraditional script. */ + HanTraditional: "HanTraditional", + + /** Script name for the Hebrew script. */ + Hebrew: "Hebrew", + + /** Script name for the Japanese script. */ + Japanese: "Japanese", + + /** Script name for the Khmer script. */ + Khmer: "Khmer", + + /** Script name for the Kannada script. */ + Kannada: "Kannada", + + /** Script name for the Lao script. */ + Lao: "Lao", + + /** Script name for the Latin script. */ + Latin: "Latin", + + /** Script name for the Malayalam script. */ + Malayalam: "Malayalam", + + /** Script name for the Myanmar script. */ + Myanmar: "Myanmar", + + /** Script name for the Odia script. */ + Odia: "Odia", + + /** Script name for the Sinhala script. */ + Sinhala: "Sinhala", + + /** Script name for the Tamil script. */ + Tamil: "Tamil", + + /** Script name for the Telugu script. */ + Telugu: "Telugu", + + /** Script name for the Thaana script. */ + Thaana: "Thaana", + + /** Script name for the Thai script. */ + Thai: "Thai", + + /** Script name for the Tibetan script. */ + Tibetan: "Tibetan", +} + +/** Identifies the script of the input document. Maps to the ISO 15924 standard script code. */ +@added(Versions.v2023_11_15_preview) +union ScriptCode { + string, + + /** Script code for the Arabic script. */ + Arab: "Arab", + + /** Script code for the Armenian script. */ + Armn: "Armn", + + /** Script code for the Bangla script. */ + Beng: "Beng", + + /** Script code for the UnifiedCanadianAboriginalSyllabics script. */ + Cans: "Cans", + + /** Script code for the Cyrillic script. */ + Cyrl: "Cyrl", + + /** Script code for the Devanagari script. */ + Deva: "Deva", + + /** Script code for the Ethiopic script. */ + Ethi: "Ethi", + + /** Script code for the Georgian script. */ + Geor: "Geor", + + /** Script code for the Greek script. */ + Grek: "Grek", + + /** Script code for the Gujarati script. */ + Gujr: "Gujr", + + /** Script code for the Gurmukhi script. */ + Guru: "Guru", + + /** Script code for the Hangul script. */ + Hang: "Hang", + + /** Script code for the HanSimplified script. */ + Hans: "Hans", + + /** Script code for the HanTraditional script. */ + Hant: "Hant", + + /** Script code for the Hebrew script. */ + Hebr: "Hebr", + + /** Script code for the Japanese script. */ + Jpan: "Jpan", + + /** Script code for the Khmer script. */ + Khmr: "Khmr", + + /** Script code for the Kannada script. */ + Knda: "Knda", + + /** Script code for the Lao script. */ + Laoo: "Laoo", + + /** Script code for the Latin script. */ + Latn: "Latn", + + /** Script code for the Malayalam script. */ + Mlym: "Mlym", + + /** Script code for the Myanmar script. */ + Mymr: "Mymr", + + /** Script code for the Odia script. */ + Orya: "Orya", + + /** Script code for the Sinhala script. */ + Sinh: "Sinh", + + /** Script code for the Tamil script. */ + Taml: "Taml", + + /** Script code for the Telugu script. */ + Telu: "Telu", + + /** Script code for the Thaana script. */ + Thaa: "Thaa", + + /** Script code for the Thai script. */ + Thai: "Thai", + + /** Script code for the Tibetan script. */ + Tibt: "Tibt", +} + +/** The object containing the analyze job LRO job state. */ +@resource("analyze-documents/jobs") +model AnalyzeDocumentsJobState { + ...JobState; + ...TasksState; + ...AnalyzeDocumentsJobStatistics; +} + +/** Contains the pagination information. */ +model Pagination { + /** The nextLink for getting the next paginated response. */ + nextLink?: string; +} + +/** Contains the analyze documents LRO errors */ +model AnalyzeDocumentsJobErrors { + /** Collection of errors encountered during processing. */ + errors: Array; +} + +/** Contains the analyze documents job statistics returned only when showStats=true. */ +model AnalyzeDocumentsJobStatistics { + /** if showStats=true was specified in the request this field will contain information about the request payload. */ + statistics?: RequestStatistics; +} + +/** Contains the analyze documents job tasks. */ +model TasksState { + /** List of tasks. */ + tasks: Tasks; +} + +/** Container for the tasks status for the LRO job. */ +model Tasks { + /** Count of completed tasks. */ + completed: int32; + + /** Count of failed tasks. */ + failed: int32; + + /** Count of inprogress tasks. */ + inProgress: int32; + + /** Count of total tasks. */ + total: int32; + + /** Enumerable of Analyze documents job results. */ + items?: Array; +} + +/** Contains the result object for the processed document. */ +model AnalyzeDocumentsResult is AnalyzeDocumentsPreBuiltResult { + /** Response by document */ + documents: Array; +} + +/** List of job statuses. */ +union Status { + string, + + /** Not started status */ + notStarted: "notStarted", + + /** Running status */ + running: "running", + + /** Succeeded status */ + succeeded: "succeeded", + + /** Failed status */ + failed: "failed", + + /** Cancelled status */ + cancelled: "cancelled", + + /** Cancelling status */ + cancelling: "cancelling", +} + +/** Contains the AnalyzeDocuments long running operation result object. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +@discriminator("kind") +model AnalyzeDocumentsLROResult { + ...TaskState; + ...TaskIdentifier; + + /** Kind of the task. */ + kind: AnalyzeDocumentsLROResultsKind; +} + +/** Contains the result object for the processed document. */ +model DocumentResult { + /** Unique, non-empty document identifier. */ + id: string; + + /** Warnings encountered while processing document. */ + warnings: Array; + + /** if showStats=true was specified in the request this field will contain information about the document payload. */ + statistics?: DocumentStatistics; +} + +model DocumentAnalysisDocumentResult is DocumentResult { + /** Location of the input document. */ + source: DocumentLocation; + + /** Array of document results generated after the analysis. */ + target: Array; +} + +/** Contains the error object with errors encountered for the processed document. */ +model AnalyzeDocumentsDocumentError { + /** Document Id. */ + id: string; + + /** Document Error. */ + error: Error; +} + +/** Contains the warnings object with warnings encountered for the processed document. */ +model DocumentWarning { + /** Warning code. */ + code: WarningCodeValue; + + /** Warning message. */ + message: string; + + /** A JSON pointer reference indicating the target object. */ + targetRef?: string; +} + +/** Defines the list of the warning codes. */ +union WarningCodeValue { + string, + + /** Long words in document warning */ + LongWordsInDocument: "LongWordsInDocument", + + /** Document truncated warning */ + DocumentTruncated: "DocumentTruncated", +} + +/** if showStats=true was specified in the request this field will contain information about the document payload. */ +model DocumentStatistics { + /** Number of documents elements recognized in the document. */ + charactersCount: int32; + + /** Number of transactions for the document. */ + transactionsCount: int32; +} + +/** Contains an input document to be analyzed by the service. */ +model MultiLanguageInput { + /** A unique, non-empty document identifier. */ + id: string; + + /** The location of the input document to process. */ + source: DocumentLocation; + + /** The location where the processed document will be stored. */ + target: DocumentLocation; + + /** (Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default. */ + language?: string; +} + +/** Contains the location of the document. */ +@discriminator("kind") +model DocumentLocation { + /** The kind of the document location. */ + kind: DocumentLocationKind; +} + +/** Enumeration of supported document locations. */ +union DocumentLocationKind { + string, + + /** The document is a URL. */ + AzureBlob: "AzureBlob", +} + +/** Document location for azure blobs. */ +model AzureBlobDocumentLocation extends DocumentLocation { + /** The kind of the document location. */ + kind: DocumentLocationKind.AzureBlob; + + /** The location of the document. */ + location: string; + + /** The user managed identity client Id to use to authenticate with the storage account */ + managedIdentityClientId?: string; +} + +/** Error response. */ +@error +model ErrorResponse is Azure.Core.Foundations.ErrorResponseBase; + +/** An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. */ +model InnerErrorModel { + /** One of a server-defined set of error codes. */ + code: InnerErrorCode; + + /** Error message. */ + message: string; + + /** Error details. */ + details?: Record; + + /** Error target. */ + target?: string; + + /** An object containing more specific information than the current object about the error. */ + innererror?: InnerErrorModel; +} + +/** Specifies the method used to interpret string offsets. Defaults to documents Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/documents-analytics-offsets. */ +union StringIndexType { + string, + + /** Returned offset and length values will correspond to textElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo. */ + TextElements_v8: "TextElements_v8", + + /** Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python. */ + UnicodeCodePoint: "UnicodeCodePoint", + + /** Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript. */ + Utf16CodeUnit: "Utf16CodeUnit", +} + +/** Returns the current state of the task. */ +model TaskState { + /** The last updated time in UTC for the task. */ + lastUpdateDateTime: utcDateTime; + + /** The status of the task at the mentioned last update time. */ + status: State; +} + +/** The status of the task at the mentioned last update time. */ +@lroStatus +union State { + string, + + /** Not started status */ + notStarted: "notStarted", + + /** Running status */ + running: "running", + + /** Succeeded status */ + @lroSucceeded + succeeded: "succeeded", + + /** Partially completed status */ + partiallyCompleted: "partiallyCompleted", + + /** Failed status */ + @lroFailed + failed: "failed", + + /** Cancelled status */ + @lroCanceled + cancelled: "cancelled", + + /** Cancelling status */ + cancelling: "cancelling", +} + +/** Base task object. */ +model TaskIdentifier { + /** task name */ + taskName?: string; +} + +/** Base parameters object for a documents analysis task. */ +model TaskParameters { + /** logging opt out */ + loggingOptOut?: boolean = false; +} + +/** Parameters object for a documents analysis task using pre-built models. */ +model PreBuiltTaskParameters is TaskParameters { + /** model version */ + modelVersion?: string = "latest"; +} + +alias ShowStatsQueryParameter = QueryParametersTrait<{ + /** (Optional) if set to true, response will contain request and document level statistics. */ + @query + showStats?: boolean; +}>; + +alias AnalyzeDocumentsJobQueryParameters = QueryParametersTrait<{ + /** (Optional) if set to true, response will contain request and document level statistics. */ + @query + showStats?: boolean; + + /** The maximum number of resources to return from the collection. */ + @query + top?: int32; + + /** An offset into the collection of the first resource to be returned. */ + @query + skip?: int32; +}>; + +alias AnalyzeDocumentsQueryParameters = { + /** (Optional) if set to true, response will contain request and document level statistics. */ + @query + showStats?: boolean; +}; + +/** job state */ +model JobState { + /** display name */ + displayName?: string; + + /** Date and time job created */ + createdDateTime: utcDateTime; + + /** Date and time job expires */ + expirationDateTime?: utcDateTime; + + /** job ID */ + @key + @visibility("read") + jobId: uuid; + + /** last updated date and time */ + lastUpdatedDateTime: utcDateTime; + + /** status */ + status: State; + + /** errors */ + errors?: Array; + + /** next link */ + nextLink?: string; +} + +/** job errors */ +model JobErrors { + /** errors */ + errors?: Array; +} + +/** Contains details of errors encountered during a job execution. */ +model DocumentError { + /** The ID of the input document. */ + id: string; + + /** Error encountered. */ + error: Error; +} + +/** Contains details of warnings encountered during a job execution. */ +model InputWarning { + /** Warning code. */ + code: string; + + /** Warning message. */ + message: string; + + /** A JSON pointer reference indicating the target object. */ + targetRef?: string; +} + +/** if showStats=true was specified in the request this field will contain information about the request payload. */ +model RequestStatistics { + /** Number of documents submitted in the request. */ + documentsCount: int32; + + /** Number of valid documents. This excludes empty, over-size limit or non-supported languages documents. */ + validDocumentsCount: int32; + + /** Number of invalid documents. This includes empty, over-size limit or non-supported languages documents. */ + erroneousDocumentsCount: int32; + + /** Number of transactions for the request. */ + transactionsCount: int64; +} + +/** Pre built result */ +model PreBuiltResult { + /** Errors by document id. */ + errors: Array; + + /** if showStats=true was specified in the request this field will contain information about the request payload. */ + statistics?: RequestStatistics; + + /** This field indicates which model is used for scoring. */ + modelVersion: string; +} + +/** Human-readable error code. */ +union InnerErrorCode { + string, + + /** Invalid request error */ + InvalidRequest: "InvalidRequest", + + /** Invalid parameter value error */ + InvalidParameterValue: "InvalidParameterValue", + + /** Knowledge base not found error */ + KnowledgeBaseNotFound: "KnowledgeBaseNotFound", + + /** Azure Cognitive Search not found error */ + AzureCognitiveSearchNotFound: "AzureCognitiveSearchNotFound", + + /** Azure Cognitive Search throttling error */ + AzureCognitiveSearchThrottling: "AzureCognitiveSearchThrottling", + + /** Extraction failure error */ + ExtractionFailure: "ExtractionFailure", + + /** Invalid request body format error */ + InvalidRequestBodyFormat: "InvalidRequestBodyFormat", + + /** Empty request error */ + EmptyRequest: "EmptyRequest", + + /** Missing input documents error */ + MissingInputDocuments: "MissingInputDocuments", + + /** Invalid document error */ + InvalidDocument: "InvalidDocument", + + /** Model version incorrect error */ + ModelVersionIncorrect: "ModelVersionIncorrect", + + /** Invalid document batch error */ + InvalidDocumentBatch: "InvalidDocumentBatch", + + /** Unsupported language code error */ + UnsupportedLanguageCode: "UnsupportedLanguageCode", + + /** Invalid country hint error */ + InvalidCountryHint: "InvalidCountryHint", +} + +/** Human-readable error code. */ +union ErrorCode { + string, + + /** Invalid request error */ + InvalidRequest: "InvalidRequest", + + /** Invalid argument error */ + InvalidArgument: "InvalidArgument", + + /** Unauthorized access error */ + Unauthorized: "Unauthorized", + + /** Forbidden access error */ + Forbidden: "Forbidden", + + /** Not found error */ + NotFound: "NotFound", + + /** Project not found error */ + ProjectNotFound: "ProjectNotFound", + + /** Operation not found error */ + OperationNotFound: "OperationNotFound", + + /** Azure Cognitive Search not found error */ + AzureCognitiveSearchNotFound: "AzureCognitiveSearchNotFound", + + /** Azure Cognitive Search index not found error */ + AzureCognitiveSearchIndexNotFound: "AzureCognitiveSearchIndexNotFound", + + /** Too many requests error */ + TooManyRequests: "TooManyRequests", + + /** Azure Cognitive Search throttling error */ + AzureCognitiveSearchThrottling: "AzureCognitiveSearchThrottling", + + /** Azure Cognitive Search index limit reached error */ + AzureCognitiveSearchIndexLimitReached: "AzureCognitiveSearchIndexLimitReached", + + /** Internal server error */ + InternalServerError: "InternalServerError", + + /** Service unavailable error */ + ServiceUnavailable: "ServiceUnavailable", + + /** Timeout error */ + Timeout: "Timeout", + + /** Quota exceeded error */ + QuotaExceeded: "QuotaExceeded", + + /** Conflict error */ + Conflict: "Conflict", + + /** Warning error */ + Warning: "Warning", +} + +/** Enum that defines the length of the output summaries. */ +union SummaryLengthBucket { + string, + + /** Instructs model to generate shorter length summaries. */ + short: "short", + + /** Instructs model to generate medium length summaries. */ + medium: "medium", + + /** Instructs model to generate longer length summaries. */ + long: "long", +} + +/** Supported parameters for an Abstractive Summarization task. */ +model AbstractiveSummarizationTaskParametersBase { + /** Controls the approximate number of sentences in the output summaries. */ + sentenceCount?: int32; + + /** String index type */ + stringIndexType?: StringIndexType = StringIndexType.TextElements_v8; + + /** (NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries. */ + summaryLength?: SummaryLengthBucket; +} + +/** The context of the summary. */ +model SummaryContext { + /** Start position for the context. Use of different 'stringIndexType' values can affect the offset returned. */ + offset: int32; + + /** The length of the context. Use of different 'stringIndexType' values can affect the length returned. */ + length: int32; +} + +/** Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction. */ +union redactionCharacter { + string, + + /** Exclamation point character */ + exclamationPoint: "!", + + /** Number sign character */ + numberSign: "#", + + /** Dollar sign character */ + dollar: "$", + + /** Percent sign character */ + perCent: "%", + + /** Ampersand character */ + ampersand: "&", + + /** Asterisk character */ + asterisk: "*", + + /** Plus sign character */ + plus: "+", + + /** Minus sign character */ + minus: "-", + + /** Equals sign character */ + equals: "=", + + /** Question mark character */ + questionMark: "?", + + /** At sign character */ + atSign: "@", + + /** Caret character */ + caret: "^", + + /** Underscore character */ + underscore: "_", + + /** Tilde character */ + tilde: "~", +} + +/** The error response object returned when the service encounters some errors during processing the request. */ +model Error { + /** One of a server-defined set of error codes. */ + code: ErrorCode; + + /** A human-readable representation of the error. */ + message: string; + + /** The target of the error. */ + target?: string; + + /** An array of details about specific errors that led to this reported error. */ + details?: Array; + + /** An object containing more specific information than the current object about the error. */ + innererror?: InnerErrorModel; +} diff --git a/specification/cognitiveservices/Language.AnalyzeDocuments/models/pii.entity.recognition.tsp b/specification/cognitiveservices/Language.AnalyzeDocuments/models/pii.entity.recognition.tsp new file mode 100644 index 000000000000..65d01190daff --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/models/pii.entity.recognition.tsp @@ -0,0 +1,631 @@ +import "@typespec/versioning"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using TypeSpec.Versioning; + +namespace Language.AnalyzeDocuments; + +/** Supported parameters for a PII Entities Recognition task. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +model PiiTaskParameters is PreBuiltTaskParameters { + /** Domain for PII task */ + domain?: PiiDomain = PiiDomain.none; + + /** Enumeration of PII categories to be returned in the response. */ + piiCategories?: Array; + + /** StringIndexType to be used for analysis. */ + stringIndexType?: StringIndexType = StringIndexType.TextElements_v8; + + /** Enumeration of PII categories to be excluded in the response. */ + excludePiiCategories?: Array; + + /** Character to be used for redaction. Default in '*'. */ + redactionCharacter?: redactionCharacter = redactionCharacter.asterisk; +} + +/** Contains the analyze text PIIEntityRecognition LRO task. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +model PiiLROTask extends AnalyzeDocumentsLROTask { + /** Kind of the task. */ + kind: AnalyzeDocumentsLROTaskKind.PiiEntityRecognition; + + /** Pii task parameters. */ + parameters?: PiiTaskParameters; +} + +/** Contains the PiiResult. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +model PiiResult is PreBuiltResult { + /** Response by document */ + documents: Array; +} + +/** PII domains. */ +union PiiDomain { + string, + + /** Indicates that entities in the Personal Health Information domain should be redacted. */ + phi: "phi", + + /** Indicates that no domain is specified. */ + none: "none", +} + +/** Contains the PII results. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +model PiiEntitiesDocumentResult is DocumentResult { + /** Returns redacted text. */ + redactedDocuments: string; + + /** Recognized entities in the document. */ + entities: Array; +} + +/** Contains the PII results with detected language. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +model PiiResultWithDetectedLanguage { + ...PiiEntitiesDocumentResult; +} + +/** Defines the detected entity object containing the entity category and entity text detected, etc. */ +model Entity { + /** Entity text as appears in the request. */ + text: string; + + /** Entity type. */ + category: string; + + /** (Optional) Entity sub type. */ + subcategory?: string; + + /** Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned. */ + offset: int32; + + /** Length for the entity text. Use of different 'stringIndexType' values can affect the length returned. */ + length: int32; + + /** Confidence score between 0 and 1 of the extracted entity. */ + confidenceScore: float64; +} + +/** (Optional) describes the PII categories to return */ +union PiiCategory { + string, + PiiCategoriesExclude, + + /** All PII categories. */ + All: "All", + + /** Default PII categories for the language. */ + Default: "Default", +} + +/** Contains the PII LRO results. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +model PiiEntityRecognitionLROResult extends AnalyzeDocumentsLROResult { + /** The kind of the task. */ + kind: AnalyzeDocumentsLROResultsKind.PiiEntityRecognitionLROResults; + + /** The list of pii document results */ + results: AnalyzeDocumentsResult; +} + +/** (Optional) describes the PII categories to return */ +union PiiCategoriesExclude { + string, + + /** ABA Routing number */ + ABARoutingNumber: "ABARoutingNumber", + + /** AR National Identity Number */ + ARNationalIdentityNumber: "ARNationalIdentityNumber", + + /** AT Identity Card */ + AUBankAccountNumber: "AUBankAccountNumber", + + /** AU Driver's License Number */ + AUDriversLicenseNumber: "AUDriversLicenseNumber", + + /** AU Medical Account Number */ + AUMedicalAccountNumber: "AUMedicalAccountNumber", + + /** AU Passport Number */ + AUPassportNumber: "AUPassportNumber", + + /** AU Tax File Number */ + AUTaxFileNumber: "AUTaxFileNumber", + + /** AU Business Number */ + AUBusinessNumber: "AUBusinessNumber", + + /** AU Company Number */ + AUCompanyNumber: "AUCompanyNumber", + + /** AT Identity Card */ + ATIdentityCard: "ATIdentityCard", + + /** AT Tax Identification Number */ + ATTaxIdentificationNumber: "ATTaxIdentificationNumber", + + /** AT Value Added Tax Number */ + ATValueAddedTaxNumber: "ATValueAddedTaxNumber", + + /** Azure Document DB Auth Key */ + AzureDocumentDBAuthKey: "AzureDocumentDBAuthKey", + + /** Azure IAAS Database Connection And SQL String */ + AzureIAASDatabaseConnectionAndSQLString: "AzureIAASDatabaseConnectionAndSQLString", + + /** Azure IoT Connection String */ + AzureIoTConnectionString: "AzureIoTConnectionString", + + /** Azure Publish Setting Password */ + AzurePublishSettingPassword: "AzurePublishSettingPassword", + + /** Azure Redis Cache String */ + AzureRedisCacheString: "AzureRedisCacheString", + + /** Azure SAS */ + AzureSAS: "AzureSAS", + + /** Azure Service Bus String */ + AzureServiceBusString: "AzureServiceBusString", + + /** Azure Storage Account Key */ + AzureStorageAccountKey: "AzureStorageAccountKey", + + /** Azure Storage Account Generic */ + AzureStorageAccountGeneric: "AzureStorageAccountGeneric", + + /** BE National Number */ + BENationalNumber: "BENationalNumber", + + /** BE National Number V2 */ + BENationalNumberV2: "BENationalNumberV2", + + /** BE Value Added Tax Number */ + BEValueAddedTaxNumber: "BEValueAddedTaxNumber", + + /** BR CPF Number */ + BRCPFNumber: "BRCPFNumber", + + /** BR Legal Entity Number */ + BRLegalEntityNumber: "BRLegalEntityNumber", + + /** BR National ID RG */ + BRNationalIDRG: "BRNationalIDRG", + + /** BG Uniform Civil Number */ + BGUniformCivilNumber: "BGUniformCivilNumber", + + /** CA Bank Account Number */ + CABankAccountNumber: "CABankAccountNumber", + + /** CA Driver's License Number */ + CADriversLicenseNumber: "CADriversLicenseNumber", + + /** CA Health Service Number */ + CAHealthServiceNumber: "CAHealthServiceNumber", + + /** CA Passport Number */ + CAPassportNumber: "CAPassportNumber", + + /** CA Personal Health Identification */ + CAPersonalHealthIdentification: "CAPersonalHealthIdentification", + + /** CA Social Insurance Number */ + CASocialInsuranceNumber: "CASocialInsuranceNumber", + + /** CL Identity Card Number */ + CLIdentityCardNumber: "CLIdentityCardNumber", + + /** CN Resident Identity Card Number */ + CNResidentIdentityCardNumber: "CNResidentIdentityCardNumber", + + /** Credit Card Number */ + CreditCardNumber: "CreditCardNumber", + + /** HR Identity Card Number */ + HRIdentityCardNumber: "HRIdentityCardNumber", + + /** HR National ID Number */ + HRNationalIDNumber: "HRNationalIDNumber", + + /** HR Personal Identification Number */ + HRPersonalIdentificationNumber: "HRPersonalIdentificationNumber", + + /** HR Personal Identification OIB Number V2 */ + HRPersonalIdentificationOIBNumberV2: "HRPersonalIdentificationOIBNumberV2", + + /** CY Identity Card */ + CYIdentityCard: "CYIdentityCard", + + /** CY Tax Identification Number */ + CYTaxIdentificationNumber: "CYTaxIdentificationNumber", + + /** CZ Personal Identity Number */ + CZPersonalIdentityNumber: "CZPersonalIdentityNumber", + + /** CZ Personal Identity V2 */ + CZPersonalIdentityV2: "CZPersonalIdentityV2", + + /** DK Personal Identification Number */ + DKPersonalIdentificationNumber: "DKPersonalIdentificationNumber", + + /** DK Personal Identification V2 */ + DKPersonalIdentificationV2: "DKPersonalIdentificationV2", + + /** Drug Enforcement Agency Number */ + DrugEnforcementAgencyNumber: "DrugEnforcementAgencyNumber", + + /** EE Personal Identification Code */ + EEPersonalIdentificationCode: "EEPersonalIdentificationCode", + + /** EU Debit Card Number */ + EUDebitCardNumber: "EUDebitCardNumber", + + /** EU Driver's License Number */ + EUDriversLicenseNumber: "EUDriversLicenseNumber", + + /** EU GPS Coordinates */ + EUGPSCoordinates: "EUGPSCoordinates", + + /** EU National Identification Number */ + EUNationalIdentificationNumber: "EUNationalIdentificationNumber", + + /** EU Passport Number */ + EUPassportNumber: "EUPassportNumber", + + /** EU Social Security Number */ + EUSocialSecurityNumber: "EUSocialSecurityNumber", + + /** EU Tax Identification Number */ + EUTaxIdentificationNumber: "EUTaxIdentificationNumber", + + /** FI European Health Number */ + FIEuropeanHealthNumber: "FIEuropeanHealthNumber", + + /** FI National ID */ + FINationalID: "FINationalID", + + /** FI National ID V2 */ + FINationalIDV2: "FINationalIDV2", + + /** FI Passport Number */ + FIPassportNumber: "FIPassportNumber", + + /** FR Driver's License Number */ + FRDriversLicenseNumber: "FRDriversLicenseNumber", + + /** FR Health Insurance Number */ + FRHealthInsuranceNumber: "FRHealthInsuranceNumber", + + /** FR National ID */ + FRNationalID: "FRNationalID", + + /** FR Passport Number */ + FRPassportNumber: "FRPassportNumber", + + /** FR Social Security Number */ + FRSocialSecurityNumber: "FRSocialSecurityNumber", + + /** FR Tax Identification Number */ + FRTaxIdentificationNumber: "FRTaxIdentificationNumber", + + /** FR Value Added Tax Number */ + FRValueAddedTaxNumber: "FRValueAddedTaxNumber", + + /** DE Driver's License Number */ + DEDriversLicenseNumber: "DEDriversLicenseNumber", + + /** DE Passport Number */ + DEPassportNumber: "DEPassportNumber", + + /** DE Identity Card Number */ + DEIdentityCardNumber: "DEIdentityCardNumber", + + /** DE Tax Identification Number */ + DETaxIdentificationNumber: "DETaxIdentificationNumber", + + /** DE Value Added Number */ + DEValueAddedNumber: "DEValueAddedNumber", + + /** GR National ID Card */ + GRNationalIDCard: "GRNationalIDCard", + + /** GR National ID V2 */ + GRNationalIDV2: "GRNationalIDV2", + + /** GR Tax Identification Number */ + GRTaxIdentificationNumber: "GRTaxIdentificationNumber", + + /** HK Identity Card Number */ + HKIdentityCardNumber: "HKIdentityCardNumber", + + /** HU Value Added Number */ + HUValueAddedNumber: "HUValueAddedNumber", + + /** HU Personal Identification Number */ + HUPersonalIdentificationNumber: "HUPersonalIdentificationNumber", + + /** HU Tax Identification Number */ + HUTaxIdentificationNumber: "HUTaxIdentificationNumber", + + /** IN Permanent Account */ + INPermanentAccount: "INPermanentAccount", + + /** IN Unique Identification Number */ + INUniqueIdentificationNumber: "INUniqueIdentificationNumber", + + /** ID Identity Card Number */ + IDIdentityCardNumber: "IDIdentityCardNumber", + + /** International Banking Account Number */ + InternationalBankingAccountNumber: "InternationalBankingAccountNumber", + + /** IE Personal Public Service Number */ + IEPersonalPublicServiceNumber: "IEPersonalPublicServiceNumber", + + /** IE Personal Public Service Number V2 */ + IEPersonalPublicServiceNumberV2: "IEPersonalPublicServiceNumberV2", + + /** IL Bank Account Number */ + ILBankAccountNumber: "ILBankAccountNumber", + + /** IL National ID */ + ILNationalID: "ILNationalID", + + /** IT Driver's License Number */ + ITDriversLicenseNumber: "ITDriversLicenseNumber", + + /** IT Fiscal Code */ + ITFiscalCode: "ITFiscalCode", + + /** IT Value Added Tax Number */ + ITValueAddedTaxNumber: "ITValueAddedTaxNumber", + + /** JP Bank Account Number */ + JPBankAccountNumber: "JPBankAccountNumber", + + /** JP Driver's License Number */ + JPDriversLicenseNumber: "JPDriversLicenseNumber", + + /** JP Passport Number */ + JPPassportNumber: "JPPassportNumber", + + /** JP Resident Registration Number */ + JPResidentRegistrationNumber: "JPResidentRegistrationNumber", + + /** JP Social Insurance Number */ + JPSocialInsuranceNumber: "JPSocialInsuranceNumber", + + /** JP My Number Corporate */ + JPMyNumberCorporate: "JPMyNumberCorporate", + + /** JP My Number Personal */ + JPMyNumberPersonal: "JPMyNumberPersonal", + + /** JP Residence Card Number */ + JPResidenceCardNumber: "JPResidenceCardNumber", + + /** LV Personal Code */ + LVPersonalCode: "LVPersonalCode", + + /** LT Personal Code */ + LTPersonalCode: "LTPersonalCode", + + /** LU National Identification Number Natural */ + LUNationalIdentificationNumberNatural: "LUNationalIdentificationNumberNatural", + + /** LU National Identification Number Non Natural */ + LUNationalIdentificationNumberNonNatural: "LUNationalIdentificationNumberNonNatural", + + /** MY Identity Card Number */ + MYIdentityCardNumber: "MYIdentityCardNumber", + + /** MT Identity Card Number */ + MTIdentityCardNumber: "MTIdentityCardNumber", + + /** MT Tax ID Number */ + MTTaxIDNumber: "MTTaxIDNumber", + + /** NL Citizens Service Number */ + NLCitizensServiceNumber: "NLCitizensServiceNumber", + + /** NL Citizens Service Number V2 */ + NLCitizensServiceNumberV2: "NLCitizensServiceNumberV2", + + /** NL Tax Identification Number */ + NLTaxIdentificationNumber: "NLTaxIdentificationNumber", + + /** NL Value Added Tax Number */ + NLValueAddedTaxNumber: "NLValueAddedTaxNumber", + + /** NZ Bank Account Number */ + NZBankAccountNumber: "NZBankAccountNumber", + + /** NZ Driver's License Number */ + NZDriversLicenseNumber: "NZDriversLicenseNumber", + + /** NZ Inland Revenue Number */ + NZInlandRevenueNumber: "NZInlandRevenueNumber", + + /** NZ Ministry Of Health Number */ + NZMinistryOfHealthNumber: "NZMinistryOfHealthNumber", + + /** NZ Social Welfare Number */ + NZSocialWelfareNumber: "NZSocialWelfareNumber", + + /** NO Identity Number */ + NOIdentityNumber: "NOIdentityNumber", + + /** PH Unified Multi Purpose ID Number */ + PHUnifiedMultiPurposeIDNumber: "PHUnifiedMultiPurposeIDNumber", + + /** PL Identity Card */ + PLIdentityCard: "PLIdentityCard", + + /** PL National ID */ + PLNationalID: "PLNationalID", + + /** PL National ID V2 */ + PLNationalIDV2: "PLNationalIDV2", + + /** PL Passport Number */ + PLPassportNumber: "PLPassportNumber", + + /** PL Tax Identification Number */ + PLTaxIdentificationNumber: "PLTaxIdentificationNumber", + + /** PL REGON Number */ + PLREGONNumber: "PLREGONNumber", + + /** PT Citizen Card Number */ + PTCitizenCardNumber: "PTCitizenCardNumber", + + /** PT Citizen Card Number V2 */ + PTCitizenCardNumberV2: "PTCitizenCardNumberV2", + + /** PT Tax Identification Number */ + PTTaxIdentificationNumber: "PTTaxIdentificationNumber", + + /** RO Personal Numerical Code */ + ROPersonalNumericalCode: "ROPersonalNumericalCode", + + /** RU Passport Number Domestic */ + RUPassportNumberDomestic: "RUPassportNumberDomestic", + + /** RU Passport Number International */ + RUPassportNumberInternational: "RUPassportNumberInternational", + + /** SA National ID */ + SANationalID: "SANationalID", + + /** SG National Registration Identity Card Number */ + SGNationalRegistrationIdentityCardNumber: "SGNationalRegistrationIdentityCardNumber", + + /** SK Personal Number */ + SKPersonalNumber: "SKPersonalNumber", + + /** SI Tax Identification Number */ + SITaxIdentificationNumber: "SITaxIdentificationNumber", + + /** SI Unique Master Citizen Number */ + SIUniqueMasterCitizenNumber: "SIUniqueMasterCitizenNumber", + + /** ZA Identification Number */ + ZAIdentificationNumber: "ZAIdentificationNumber", + + /** KR Resident Registration Number */ + KRResidentRegistrationNumber: "KRResidentRegistrationNumber", + + /** ES DNI */ + ESDNI: "ESDNI", + + /** ES Social Security Number */ + ESSocialSecurityNumber: "ESSocialSecurityNumber", + + /** ES Tax Identification Number */ + ESTaxIdentificationNumber: "ESTaxIdentificationNumber", + + /** SQL Server Connection String */ + SQLServerConnectionString: "SQLServerConnectionString", + + /** SE National ID */ + SENationalID: "SENationalID", + + /** SE National ID V2 */ + SENationalIDV2: "SENationalIDV2", + + /** SE Passport Number */ + SEPassportNumber: "SEPassportNumber", + + /** SE Tax Identification Number */ + SETaxIdentificationNumber: "SETaxIdentificationNumber", + + /** SWIFT Code */ + SWIFTCode: "SWIFTCode", + + /** CH Social Security Number */ + CHSocialSecurityNumber: "CHSocialSecurityNumber", + + /** TW National ID */ + TWNationalID: "TWNationalID", + + /** TW Passport Number */ + TWPassportNumber: "TWPassportNumber", + + /** TW Resident Certificate */ + TWResidentCertificate: "TWResidentCertificate", + + /** TH Population Identification Code */ + THPopulationIdentificationCode: "THPopulationIdentificationCode", + + /** TR National Identification Number */ + TRNationalIdentificationNumber: "TRNationalIdentificationNumber", + + /** UK Driver's License Number */ + UKDriversLicenseNumber: "UKDriversLicenseNumber", + + /** UK Electoral Roll Number */ + UKElectoralRollNumber: "UKElectoralRollNumber", + + /** UK National Health Number */ + UKNationalHealthNumber: "UKNationalHealthNumber", + + /** UK National Insurance Number */ + UKNationalInsuranceNumber: "UKNationalInsuranceNumber", + + /** UK Unique Taxpayer Number */ + UKUniqueTaxpayerNumber: "UKUniqueTaxpayerNumber", + + /** US UK Passport Number */ + USUKPassportNumber: "USUKPassportNumber", + + /** US Bank Account Number */ + USBankAccountNumber: "USBankAccountNumber", + + /** US Driver's License Number */ + USDriversLicenseNumber: "USDriversLicenseNumber", + + /** US Individual Taxpayer Identification */ + USIndividualTaxpayerIdentification: "USIndividualTaxpayerIdentification", + + /** US Social Security Number */ + USSocialSecurityNumber: "USSocialSecurityNumber", + + /** UA Passport Number Domestic */ + UAPassportNumberDomestic: "UAPassportNumberDomestic", + + /** UA Passport Number International */ + UAPassportNumberInternational: "UAPassportNumberInternational", + + /** Organization */ + Organization: "Organization", + + /** Email */ + Email: "Email", + + /** URL */ + URL: "URL", + + /** Age */ + Age: "Age", + + /** Phone Number */ + PhoneNumber: "PhoneNumber", + + /** IP Address */ + IPAddress: "IPAddress", + + /** Date */ + Date: "Date", + + /** Person */ + Person: "Person", + + /** Address */ + Address: "Address", +} diff --git a/specification/cognitiveservices/Language.AnalyzeDocuments/models/summarization.tsp b/specification/cognitiveservices/Language.AnalyzeDocuments/models/summarization.tsp new file mode 100644 index 000000000000..143d2a9f4e26 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/models/summarization.tsp @@ -0,0 +1,167 @@ +import "@typespec/versioning"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using TypeSpec.Versioning; + +namespace Language.AnalyzeDocuments; + +/** Supported parameters for an Extractive Summarization task. */ +@added(Versions.v2023_11_15_preview) +model ExtractiveSummarizationTaskParameters is PreBuiltTaskParameters { + /** Specifies the number of sentences in the extracted summary. */ + sentenceCount?: int64 = 3; + + /** Specifies how to sort the extracted summaries. */ + sortBy?: ExtractiveSummarizationSortingCriteria = ExtractiveSummarizationSortingCriteria.Offset; + + /** Specifies the method used to interpret string offsets. */ + stringIndexType?: StringIndexType = StringIndexType.TextElements_v8; + + /** (Optional) If provided, the query will be used to extract most relevant sentences from the document. */ + @added(Versions.v2023_11_15_preview) + query?: string; +} + +/** An object representing the task definition for an Extractive Summarization task. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +@added(Versions.v2023_11_15_preview) +model ExtractiveSummarizationLROTask extends AnalyzeDocumentsLROTask { + /** The Extractive Summarization kind of the long running task. */ + kind: AnalyzeDocumentsLROTaskKind.ExtractiveSummarization; + + /** Parameters for the Extractive Summarization task. */ + parameters?: ExtractiveSummarizationTaskParameters; +} + +/** An object representing the pre-built Extractive Summarization results of each document. */ +@added(Versions.v2023_11_15_preview) +model ExtractiveSummarizationResult is PreBuiltResult { + /** Response by document */ + @added(Versions.v2023_11_15_preview) + @typeChangedFrom( + Versions.v2023_11_15_preview, + Array + ) + documents: Array; +} + +/** The sorting criteria to use for the results of Extractive Summarization. */ +@added(Versions.v2023_11_15_preview) +union ExtractiveSummarizationSortingCriteria { + string, + + /** Indicates that results should be sorted in order of appearance in the text. */ + Offset: "Offset", + + /** Indicates that results should be sorted in order of importance (i.e. rank score) according to the model. */ + Rank: "Rank", +} + +/** A ranked list of sentences representing the extracted summary. */ +@added(Versions.v2023_11_15_preview) +model ExtractedSummaryDocumentResult is DocumentResult { + /** Specifies the the extracted sentences from the input document. */ + sentences: Array; +} + +/** A ranked list of sentences representing the extracted summary. */ +@added(Versions.v2023_11_15_preview) +model ExtractedSummaryDocumentResultWithDetectedLanguage + is ExtractedSummaryDocumentResult { + ...DocumentDetectedLanguage; +} + +/** Represents an extracted sentences from the input document. */ +@added(Versions.v2023_11_15_preview) +model ExtractedSummarySentence { + /** The extracted sentence text. */ + text: string; + + /** A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance. */ + rankScore: float64; + + /** The sentence offset from the start of the document, based on the value of the parameter StringIndexType. */ + offset: int32; + + /** The length of the sentence. */ + length: int32; +} + +/** An object representing the results for an Extractive Summarization task. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +@added(Versions.v2023_11_15_preview) +model ExtractiveSummarizationLROResult extends AnalyzeDocumentsLROResult { + /** Kind of the task. */ + kind: AnalyzeDocumentsLROResultsKind.ExtractiveSummarizationLROResults; + + /** Results of the document task. */ + results: AnalyzeDocumentsResult; +} + +/** An object representing the task definition for an Abstractive Summarization task. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +@added(Versions.v2023_11_15_preview) +model AbstractiveSummarizationLROTask extends AnalyzeDocumentsLROTask { + /** The Abstractive Summarization kind of the long running task. */ + kind: AnalyzeDocumentsLROTaskKind.AbstractiveSummarization; + + /** Parameters for the Abstractive Summarization task. */ + parameters: AbstractiveSummarizationTaskParameters; +} + +/** Supported parameters for the pre-built Abstractive Summarization task. */ +@added(Versions.v2023_11_15_preview) +model AbstractiveSummarizationTaskParameters is PreBuiltTaskParameters { + ...AbstractiveSummarizationTaskParametersBase; + + /** (Optional) If provided, the query will be used to generate the summary. */ + query?: string; +} + +/** An object representing the results for an Abstractive Summarization task. */ +#suppress "@azure-tools/typespec-azure-core/casing-style" +model AbstractiveSummarizationLROResult extends AnalyzeDocumentsLROResult { + /** Kind of the task. */ + kind: AnalyzeDocumentsLROResultsKind.AbstractiveSummarizationLROResults; + + /** Results of the task. */ + results: AbstractiveSummarizationResult; +} + +/** An object representing the summarization results of each document. */ +@added(Versions.v2023_11_15_preview) +model AbstractiveSummarizationResultBase { + /** Response by document */ + documents: Array; +} + +/** An object representing the pre-built Abstractive Summarization results of each document. */ +@added(Versions.v2023_11_15_preview) +model AbstractiveSummarizationResult is PreBuiltResult { + ...AbstractiveSummarizationResultBase; +} + +/** An object representing the pre-built Abstractive Summarization results of each document. */ +@added(Versions.v2023_11_15_preview) +model AbstractiveSummaryDocumentResult is DocumentResult { + /** A list of abstractive summaries. */ + summaries: Array; +} + +/** An object representing the Abstractive Summarization result of a single document with detected language. */ +@added(Versions.v2023_11_15_preview) +model AbstractiveSummaryDocumentResultWithDetectedLanguage + is AbstractiveSummaryDocumentResult { + ...DocumentDetectedLanguage; +} + +/** An object representing a single summary with context for given document. */ +@added(Versions.v2023_11_15_preview) +model AbstractiveSummary { + /** The text of the summary. */ + text: string; + + /** The context list of the summary. */ + contexts?: Array; +} diff --git a/specification/cognitiveservices/Language.AnalyzeDocuments/tspconfig.yaml b/specification/cognitiveservices/Language.AnalyzeDocuments/tspconfig.yaml new file mode 100644 index 000000000000..b25f63077995 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/tspconfig.yaml @@ -0,0 +1,22 @@ +parameters: + "service-dir": + default: "sdk/cognitivelanguage" +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" +options: + "@azure-tools/typespec-autorest": + omit-unreachable-types: true + azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/Language/{version-status}/{version}/analyzedocuments.json" + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Language.Documents" + clear-output-folder: true + model-namespace: false + namespace: "Azure.AI.Language.Documents" + flavor: azure diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzedocuments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzedocuments.json index ed5209c28939..49964563bb20 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzedocuments.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzedocuments.json @@ -2,411 +2,552 @@ "swagger": "2.0", "info": { "title": "Microsoft Cognitive Language Service - Document Analysis", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/azure/cognitive-services/language-service/overview.0", - "version": "2023-11-15-preview" - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + "version": "2023-11-15-preview", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms.\nThe API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering.\nFurther documentation can be found in https://docs.microsoft.com/azure/cognitive-services/language-service/overview.0", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } + ] }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } + "schemes": [ + "https" ], "x-ms-parameterized-host": { "hostTemplate": "{Endpoint}/language", "useSchemePrefix": false, "parameters": [ { - "$ref": "common.json#/parameters/Endpoint" + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "required": true, + "type": "string" } ] }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "tags": [], "paths": { "/analyze-documents/jobs": { "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "description": "Submit a collection of documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", - "operationId": "AnalyzeDocuments_SubmitJob", - "summary": "Submit document analysis job", + "operationId": "AnalyzeDocumentsSubmitJob", + "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", "parameters": [ { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "description": "Collection of documents to analyze and one or more tasks to execute.", - "in": "body", "name": "body", + "in": "body", + "description": "The input for the analyze documents operation.", + "required": true, "schema": { "$ref": "#/definitions/AnalyzeDocumentJobsInput" - }, - "required": true + } } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Operation-Location": { - "type": "string" + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Successful PII redaction Request": { - "$ref": "./examples/analyzedocuments/SuccessfulPiiTaskSubmit.json" + "SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest": { + "$ref": "./examples/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json" } - } + }, + "x-ms-long-running-operation": true } }, "/analyze-documents/jobs/{jobId}": { "get": { - "produces": [ - "application/json" - ], - "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", - "operationId": "AnalyzeDocuments_JobStatus", + "operationId": "AnalyzeDocumentsJobStatus", "summary": "Get analysis status and results", + "description": "Get the status of a document analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.", "parameters": [ { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/JobId" + "name": "jobId", + "in": "path", + "description": "job ID", + "required": true, + "type": "string", + "format": "uuid" }, { - "$ref": "#/parameters/ShowStats" + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "required": false, + "type": "boolean" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "Analysis job status and metadata.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AnalyzeDocumentsJobState" } }, "default": { - "description": "Unexpected error", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } } } }, "x-ms-examples": { - "Successful PII redaction Result": { - "$ref": "./examples/analyzedocuments/SuccessfulPiiTaskResult.json" + "SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest": { + "$ref": "./examples/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json" } } } }, "/analyze-documents/jobs/{jobId}:cancel": { "post": { - "produces": [ - "application/json" - ], - "description": "Cancel a long-running Document Analysis job.", - "operationId": "AnalyzeDocuments_CancelJob", - "summary": "Cancel a long-running Document Analysis job", + "operationId": "AnalyzeDocumentsCancelJob", + "summary": "Cancel a long-running Text Analysis job.", + "description": "Cancel a long-running Text Analysis job.", "parameters": [ { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/JobId" + "name": "jobId", + "in": "path", + "description": "The job ID to cancel.", + "required": true, + "type": "string", + "format": "uuid" } ], "responses": { "202": { - "description": "Cancel Job request has been received.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Operation-Location": { - "type": "string" + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Unexpected error", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Successful job cancellation request": { - "$ref": "./examples/analyzedocuments/SuccessfulAnalyzeTextJobsCancelRequest.json" + "SuccessfulAnalyzeDocumentsJobsCancelRequest": { + "$ref": "./examples/SuccessfulAnalyzeDocumentsJobsCancelRequest.json" } - } + }, + "x-ms-long-running-operation": true } } }, "definitions": { - "AnalyzeDocumentJobsInput": { + "AbstractiveSummarizationLROResult": { "type": "object", + "description": "An object representing the results for an Abstractive Summarization task.", "properties": { - "displayName": { - "description": "Optional display name for the analysis job.", - "type": "string" - }, - "analysisInput": { - "$ref": "#/definitions/MultiLanguageAnalysisInput" - }, - "tasks": { - "description": "The set of tasks to execute on the input documents.", - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeDocumentsLROTask" - } + "results": { + "$ref": "#/definitions/AbstractiveSummarizationResult", + "description": "Results of the task." } }, "required": [ - "analysisInput", - "tasks" - ] + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeDocumentsLROResult" + } + ], + "x-ms-discriminator-value": "AbstractiveSummarizationLROResults" }, - "MultiLanguageAnalysisInput": { + "AbstractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Abstractive Summarization task.", + "properties": { + "parameters": { + "$ref": "#/definitions/AbstractiveSummarizationTaskParameters", + "description": "Parameters for the Abstractive Summarization task." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeDocumentsLROTask" + } + ], + "x-ms-discriminator-value": "AbstractiveSummarization" + }, + "AbstractiveSummarizationResult": { "type": "object", + "description": "An object representing the pre-built Abstractive Summarization results of each document.", "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, "documents": { "type": "array", + "description": "Response by document", "items": { - "$ref": "#/definitions/MultiLanguageInput" + "$ref": "#/definitions/AbstractiveSummaryDocumentResultWithDetectedLanguage" } } - } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] }, - "MultiLanguageInput": { + "AbstractiveSummarizationTaskParameters": { "type": "object", - "description": "Contains an input document to be analyzed by the service.", - "required": [ - "id", - "source", - "target" - ], + "description": "Supported parameters for the pre-built Abstractive Summarization task.", "properties": { - "id": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { "type": "string", - "description": "A unique, non-empty document identifier." + "description": "model version", + "default": "latest" }, - "source": { - "$ref": "#/definitions/DocumentLocation" + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "Controls the approximate number of sentences in the output summaries." }, - "target": { - "$ref": "#/definitions/DocumentLocation" + "stringIndexType": { + "type": "string", + "description": "String index type", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to textElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } }, - "language": { + "summaryLength": { + "$ref": "#/definitions/SummaryLengthBucket", + "description": "(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries." + }, + "query": { "type": "string", - "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. For Auto Language Detection, use \"auto\". If not set, use \"en\" for English as default." + "description": "(Optional) If provided, the query will be used to generate the summary." } } }, - "DocumentLocation": { + "AbstractiveSummary": { "type": "object", - "discriminator": "kind", + "description": "An object representing a single summary with context for given document.", "properties": { - "kind": { - "$ref": "#/definitions/DocumentLocationKind" + "text": { + "type": "string", + "description": "The text of the summary." + }, + "contexts": { + "type": "array", + "description": "The context list of the summary.", + "items": { + "$ref": "#/definitions/SummaryContext" + }, + "x-ms-identifiers": [] } }, "required": [ - "kind" + "text" ] }, - "AzureBlobDocumentLocation": { + "AbstractiveSummaryDocumentResultWithDetectedLanguage": { "type": "object", + "description": "An object representing the Abstractive Summarization result of a single document with detected language.", "properties": { - "location": { - "description": "Location of the file to process", - "type": "string" + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." }, - "managedIdentityClientId": { - "description": "The managed identity client Id to use to authenticate with the storage account", - "type": "string" + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + }, + "x-ms-identifiers": [] + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "summaries": { + "type": "array", + "description": "A list of abstractive summaries.", + "items": { + "$ref": "#/definitions/AbstractiveSummary" + }, + "x-ms-identifiers": [] + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." } }, - "allOf": [ - { - "$ref": "#/definitions/DocumentLocation" - } - ], "required": [ - "location" - ], - "x-ms-discriminator-value": "AzureBlob" - }, - "DocumentLocationKind": { - "type": "string", - "description": "Enumeration of supported document locations.", - "enum": [ - "AzureBlob" - ], - "x-ms-enum": { - "name": "DocumentLocationKind", - "modelAsString": true, - "values": [ - { - "name": "AzureBlob", - "value": "AzureBlob", - "description": "The document is a URL." - } - ] - } + "id", + "warnings", + "summaries" + ] }, - "AnalyzeDocumentsLROTask": { + "AnalyzeDocumentJobsInput": { "type": "object", - "discriminator": "kind", - "required": [ - "kind" - ], + "description": "The input object for the analyze documents LRO.", "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeDocumentsLROTaskKind" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskIdentifier" - } - ] - }, - "AnalyzeDocumentsLROTaskKind": { - "type": "string", - "description": "Enumeration of supported long-running Document Analysis tasks.", - "enum": [ - "PiiEntityRecognition", - "ExtractiveSummarization", - "AbstractiveSummarization" - ], - "x-ms-enum": { - "name": "AnalyzeDocumentsLROTaskKind", - "modelAsString": true - } - }, - "AnalyzeDocumentsJobState": { - "allOf": [ - { - "$ref": "common.json#/definitions/JobState" + "displayName": { + "type": "string", + "description": "Name for the task." }, - { - "$ref": "#/definitions/TasksState" + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input to be analyzed." }, - { - "$ref": "#/definitions/AnalyzeDocumentsJobStatistics" + "tasks": { + "type": "array", + "description": "List of tasks to be performed as part of the LRO.", + "items": { + "$ref": "#/definitions/AnalyzeDocumentsLROTask" + }, + "x-ms-identifiers": [] + }, + "defaultLanguage": { + "type": "string", + "description": "Default language to use for records." } + }, + "required": [ + "analysisInput", + "tasks" ] }, - "AnalyzeDocumentsJobStatistics": { + "AnalyzeDocumentsDocumentError": { + "type": "object", + "description": "Contains the error object with errors encountered for the processed document.", "properties": { - "statistics": { - "$ref": "common.json#/definitions/RequestStatistics" + "id": { + "type": "string", + "description": "Document Id." + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Document Error." } }, - "type": "object" + "required": [ + "id", + "error" + ] }, - "TasksState": { + "AnalyzeDocumentsJobState": { + "type": "object", + "description": "The object containing the analyze job LRO job state.", "properties": { - "tasks": { - "properties": { - "completed": { - "type": "integer", - "format": "int64" - }, - "failed": { - "type": "integer", - "format": "int64" - }, - "inProgress": { - "type": "integer", - "format": "int64" - }, - "total": { - "type": "integer", - "format": "int64" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzeDocumentsLROResult" - } - } + "displayName": { + "type": "string", + "description": "display name" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job created" + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job expires" + }, + "jobId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "job ID", + "readOnly": true + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "last updated date and time" + }, + "status": { + "$ref": "#/definitions/State", + "description": "status" + }, + "errors": { + "type": "array", + "description": "errors", + "items": { + "$ref": "#/definitions/Error" }, - "required": [ - "total", - "completed", - "failed", - "inProgress" - ], - "type": "object" + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "next link" + }, + "tasks": { + "$ref": "#/definitions/Tasks", + "description": "List of tasks." + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." } }, "required": [ + "createdDateTime", + "jobId", + "lastUpdatedDateTime", + "status", "tasks" - ], - "type": "object" + ] }, "AnalyzeDocumentsLROResult": { "type": "object", + "description": "Contains the AnalyzeDocuments long running operation result object.", "properties": { - "kind": { - "$ref": "#/definitions/AnalyzeDocumentsLROResultsKind" + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The last updated time in UTC for the task." }, - "results": { - "$ref": "#/definitions/AnalyzeDocumentsLROTaskResult" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TaskState" + "status": { + "$ref": "#/definitions/State", + "description": "The status of the task at the mentioned last update time." }, - { - "$ref": "#/definitions/TaskIdentifier" + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeDocumentsLROResultsKind", + "description": "Kind of the task." } - ], + }, + "discriminator": "kind", "required": [ + "lastUpdateDateTime", + "status", "kind" ] }, "AnalyzeDocumentsLROResultsKind": { "type": "string", - "description": "Enumeration of supported Document Analysis long-running operation task results.", + "description": "The kind of the response object returned by the analyze-documents long running task.", "enum": [ "PiiEntityRecognitionLROResults", "ExtractiveSummarizationLROResults", @@ -414,84 +555,138 @@ ], "x-ms-enum": { "name": "AnalyzeDocumentsLROResultsKind", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "PiiEntityRecognitionLROResults", + "value": "PiiEntityRecognitionLROResults", + "description": "PII entity recognition LRO results" + }, + { + "name": "ExtractiveSummarizationLROResults", + "value": "ExtractiveSummarizationLROResults", + "description": "Extractive summarization LRO results" + }, + { + "name": "AbstractiveSummarizationLROResults", + "value": "AbstractiveSummarizationLROResults", + "description": "Abstractive summarization LRO results" + } + ] } }, - "TaskState": { + "AnalyzeDocumentsLROTask": { + "type": "object", + "description": "The long running task to be performed by the service on the input documents.", "properties": { - "lastUpdateDateTime": { - "format": "date-time", - "type": "string" - }, - "status": { + "taskName": { "type": "string", - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "State" - } + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeDocumentsLROTaskKind", + "description": "The kind of task to perform." } }, + "discriminator": "kind", "required": [ - "status", - "lastUpdateDateTime" + "kind" + ] + }, + "AnalyzeDocumentsLROTaskKind": { + "type": "string", + "description": "The kind of the long running analyze documents tasks supported.", + "enum": [ + "PiiEntityRecognition", + "ExtractiveSummarization", + "AbstractiveSummarization" ], - "type": "object" + "x-ms-enum": { + "name": "AnalyzeDocumentsLROTaskKind", + "modelAsString": true, + "values": [ + { + "name": "PiiEntityRecognition", + "value": "PiiEntityRecognition", + "description": "PII entity recognition task" + }, + { + "name": "ExtractiveSummarization", + "value": "ExtractiveSummarization", + "description": "Extractive summarization task" + }, + { + "name": "AbstractiveSummarization", + "value": "AbstractiveSummarization", + "description": "Abstractive summarization task" + } + ] + } }, - "AnalyzeDocumentsLROTaskResult": { + "AnalyzeDocumentsResult": { "type": "object", + "description": "Contains the result object for the processed document.", "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/AnalyzeDocumentsDocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for analysis." + }, "documents": { "type": "array", "description": "Response by document", "items": { - "$ref": "#/definitions/DocumentResultWithDetectedLanguage" + "$ref": "#/definitions/DocumentAnalysisDocumentResult" } } }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltResult" - } - ], "required": [ + "errors", + "modelVersion", "documents" ] }, - "DocumentResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" }, - "DocumentDetectedLanguage": { + "AzureBlobDocumentLocation": { "type": "object", + "description": "Document location for azure blobs.", "properties": { - "detectedLanguage": { - "$ref": "#/definitions/DetectedLanguage", - "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + "location": { + "type": "string", + "description": "The location of the document." + }, + "managedIdentityClientId": { + "type": "string", + "description": "The user managed identity client Id to use to authenticate with the storage account" } - } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/DocumentLocation" + } + ], + "x-ms-discriminator-value": "AzureBlob" }, "DetectedLanguage": { "type": "object", - "required": [ - "name", - "iso6391Name", - "confidenceScore" - ], + "description": "Contains the details of the detected language for the text.", "properties": { "name": { "type": "string", @@ -505,15 +700,25 @@ "type": "number", "format": "double", "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." + }, + "script": { + "$ref": "#/definitions/ScriptKind", + "description": "Identifies the script of the input document." + }, + "scriptCode": { + "$ref": "#/definitions/ScriptCode", + "description": "Identifies the script of the input document." } - } + }, + "required": [ + "name", + "iso6391Name", + "confidenceScore" + ] }, - "DocumentResult": { + "DocumentAnalysisDocumentResult": { "type": "object", - "required": [ - "id", - "warnings" - ], + "description": "Contains the result object for the processed document.", "properties": { "id": { "type": "string", @@ -524,65 +729,91 @@ "description": "Warnings encountered while processing document.", "items": { "$ref": "#/definitions/DocumentWarning" - } + }, + "x-ms-identifiers": [] }, "statistics": { - "description": "if showStats=true was specified in the request this field will contain information about the document payload.", - "$ref": "#/definitions/DocumentStatistics" + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." }, "source": { "$ref": "#/definitions/DocumentLocation", - "description": "The location of the input document." + "description": "Location of the input document." }, "target": { "type": "array", - "description": "The location of the result files.", + "description": "Array of document results generated after the analysis.", "items": { "$ref": "#/definitions/DocumentLocation" - } + }, + "x-ms-identifiers": [] } - } + }, + "required": [ + "id", + "warnings", + "source", + "target" + ] }, - "DocumentWarning": { + "DocumentError": { "type": "object", - "required": [ - "code", - "message" - ], + "description": "Contains details of errors encountered during a job execution.", "properties": { - "code": { - "type": "string", - "enum": [ - "LongWordsInDocument", - "DocumentTruncated" - ], - "x-ms-enum": { - "name": "WarningCodeValue", - "modelAsString": true - }, - "description": "Error code." - }, - "message": { + "id": { "type": "string", - "description": "Warning message." + "description": "The ID of the input document." }, - "targetRef": { - "type": "string", - "description": "A JSON pointer reference indicating the target object." + "error": { + "$ref": "#/definitions/Error", + "description": "Error encountered." } - } + }, + "required": [ + "id", + "error" + ] }, - "DocumentStatistics": { + "DocumentLocation": { "type": "object", + "description": "Contains the location of the document.", + "properties": { + "kind": { + "$ref": "#/definitions/DocumentLocationKind", + "description": "The kind of the document location." + } + }, + "discriminator": "kind", "required": [ - "charactersCount", - "transactionsCount" + "kind" + ] + }, + "DocumentLocationKind": { + "type": "string", + "description": "Enumeration of supported document locations.", + "enum": [ + "AzureBlob" ], + "x-ms-enum": { + "name": "DocumentLocationKind", + "modelAsString": true, + "values": [ + { + "name": "AzureBlob", + "value": "AzureBlob", + "description": "The document is a URL." + } + ] + } + }, + "DocumentStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", "properties": { "charactersCount": { "type": "integer", "format": "int32", - "description": "Number of text elements recognized in the document." + "description": "Number of documents elements recognized in the document." }, "transactionsCount": { "type": "integer", @@ -590,32 +821,495 @@ "description": "Number of transactions for the document." } }, - "description": "if showStats=true was specified in the request this field will contain information about the document payload." + "required": [ + "charactersCount", + "transactionsCount" + ] }, - "PiiLROTask": { + "DocumentWarning": { "type": "object", - "description": "An object representing the task definition for a PII Entities Recognition task.", + "description": "Contains the warnings object with warnings encountered for the processed document.", "properties": { - "parameters": { - "$ref": "#/definitions/PiiTaskParameters" + "code": { + "$ref": "#/definitions/WarningCodeValue", + "description": "Warning code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." } }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeDocumentsLROTask" - } - ], - "x-ms-discriminator-value": "PiiEntityRecognition" + "required": [ + "code", + "message" + ] }, - "PiiCategory": { - "type": "string", - "description": "(Optional) describes the PII categories to return", - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", + "Error": { + "type": "object", + "description": "The error response object returned when the service encounters some errors during processing the request.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument", + "description": "Invalid argument error" + }, + { + "name": "Unauthorized", + "value": "Unauthorized", + "description": "Unauthorized access error" + }, + { + "name": "Forbidden", + "value": "Forbidden", + "description": "Forbidden access error" + }, + { + "name": "NotFound", + "value": "NotFound", + "description": "Not found error" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound", + "description": "Project not found error" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound", + "description": "Operation not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound", + "description": "Azure Cognitive Search index not found error" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests", + "description": "Too many requests error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached", + "description": "Azure Cognitive Search index limit reached error" + }, + { + "name": "InternalServerError", + "value": "InternalServerError", + "description": "Internal server error" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable", + "description": "Service unavailable error" + }, + { + "name": "Timeout", + "value": "Timeout", + "description": "Timeout error" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded", + "description": "Quota exceeded error" + }, + { + "name": "Conflict", + "value": "Conflict", + "description": "Conflict error" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning error" + } + ] + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "ExtractiveSummarizationLROResult": { + "type": "object", + "description": "An object representing the results for an Extractive Summarization task.", + "properties": { + "results": { + "$ref": "#/definitions/AnalyzeDocumentsResult", + "description": "Results of the document task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeDocumentsLROResult" + } + ], + "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" + }, + "ExtractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Extractive Summarization task.", + "properties": { + "parameters": { + "$ref": "#/definitions/ExtractiveSummarizationTaskParameters", + "description": "Parameters for the Extractive Summarization task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeDocumentsLROTask" + } + ], + "x-ms-discriminator-value": "ExtractiveSummarization" + }, + "ExtractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for an Extractive Summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "sentenceCount": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of sentences in the extracted summary.", + "default": 3 + }, + "sortBy": { + "type": "string", + "description": "Specifies how to sort the extracted summaries.", + "default": "Offset", + "enum": [ + "Offset", + "Rank" + ], + "x-ms-enum": { + "name": "ExtractiveSummarizationSortingCriteria", + "modelAsString": true, + "values": [ + { + "name": "Offset", + "value": "Offset", + "description": "Indicates that results should be sorted in order of appearance in the text." + }, + { + "name": "Rank", + "value": "Rank", + "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model." + } + ] + } + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to textElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "query": { + "type": "string", + "description": "(Optional) If provided, the query will be used to extract most relevant sentences from the document." + } + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue", + "description": "Invalid parameter value error" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound", + "description": "Knowledge base not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure", + "description": "Extraction failure error" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format error" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest", + "description": "Empty request error" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments", + "description": "Missing input documents error" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument", + "description": "Invalid document error" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect", + "description": "Model version incorrect error" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch", + "description": "Invalid document batch error" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code error" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint", + "description": "Invalid country hint error" + } + ] + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "MultiLanguageAnalysisInput": { + "type": "object", + "description": "Collection of input documents to be analyzed by the service.", + "properties": { + "documents": { + "type": "array", + "description": "The input documents to be analyzed.", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + } + }, + "MultiLanguageInput": { + "type": "object", + "description": "Contains an input document to be analyzed by the service.", + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "source": { + "$ref": "#/definitions/DocumentLocation", + "description": "The location of the input document to process." + }, + "target": { + "$ref": "#/definitions/DocumentLocation", + "description": "The location where the processed document will be stored." + }, + "language": { + "type": "string", + "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \\\"en\\\" for English; \\\"es\\\" for Spanish etc. If not set, use \\\"en\\\" for English as default." + } + }, + "required": [ + "id", + "source", + "target" + ] + }, + "PiiCategoriesExclude": { + "type": "string", + "description": "(Optional) describes the PII categories to return", + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", "AUPassportNumber", "AUTaxFileNumber", "AUBusinessNumber", @@ -781,12 +1475,10 @@ "IPAddress", "Date", "Person", - "Address", - "All", - "Default" + "Address" ], "x-ms-enum": { - "name": "PiiCategory", + "name": "PiiCategoriesExclude", "modelAsString": true, "values": [ { @@ -1643,595 +2335,1861 @@ "name": "Address", "value": "Address", "description": "Address" - }, - { - "name": "All", - "value": "All", - "description": "All PII categories." - }, - { - "name": "Default", - "value": "Default", - "description": "Default PII categories for the language." } ] } }, - "PiiTaskParameters": { - "type": "object", - "description": "Supported parameters for a PII Entities Recognition task.", - "properties": { - "domain": { - "$ref": "#/definitions/PiiDomain" - }, - "piiCategories": { - "$ref": "#/definitions/PiiCategory" - }, - "excludePiiCategories": { - "$ref": "#/definitions/PiiCategoriesExclude" + "PiiCategory": { + "type": "string", + "description": "(Optional) describes the PII categories to return", + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "All", + "Default" + ], + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true, + "values": [ + { + "name": "ABARoutingNumber", + "value": "ABARoutingNumber", + "description": "ABA Routing number" + }, + { + "name": "ARNationalIdentityNumber", + "value": "ARNationalIdentityNumber", + "description": "AR National Identity Number" + }, + { + "name": "AUBankAccountNumber", + "value": "AUBankAccountNumber", + "description": "AT Identity Card" + }, + { + "name": "AUDriversLicenseNumber", + "value": "AUDriversLicenseNumber", + "description": "AU Driver's License Number" + }, + { + "name": "AUMedicalAccountNumber", + "value": "AUMedicalAccountNumber", + "description": "AU Medical Account Number" + }, + { + "name": "AUPassportNumber", + "value": "AUPassportNumber", + "description": "AU Passport Number" + }, + { + "name": "AUTaxFileNumber", + "value": "AUTaxFileNumber", + "description": "AU Tax File Number" + }, + { + "name": "AUBusinessNumber", + "value": "AUBusinessNumber", + "description": "AU Business Number" + }, + { + "name": "AUCompanyNumber", + "value": "AUCompanyNumber", + "description": "AU Company Number" + }, + { + "name": "ATIdentityCard", + "value": "ATIdentityCard", + "description": "AT Identity Card" + }, + { + "name": "ATTaxIdentificationNumber", + "value": "ATTaxIdentificationNumber", + "description": "AT Tax Identification Number" + }, + { + "name": "ATValueAddedTaxNumber", + "value": "ATValueAddedTaxNumber", + "description": "AT Value Added Tax Number" + }, + { + "name": "AzureDocumentDBAuthKey", + "value": "AzureDocumentDBAuthKey", + "description": "Azure Document DB Auth Key" + }, + { + "name": "AzureIAASDatabaseConnectionAndSQLString", + "value": "AzureIAASDatabaseConnectionAndSQLString", + "description": "Azure IAAS Database Connection And SQL String" + }, + { + "name": "AzureIoTConnectionString", + "value": "AzureIoTConnectionString", + "description": "Azure IoT Connection String" + }, + { + "name": "AzurePublishSettingPassword", + "value": "AzurePublishSettingPassword", + "description": "Azure Publish Setting Password" + }, + { + "name": "AzureRedisCacheString", + "value": "AzureRedisCacheString", + "description": "Azure Redis Cache String" + }, + { + "name": "AzureSAS", + "value": "AzureSAS", + "description": "Azure SAS" + }, + { + "name": "AzureServiceBusString", + "value": "AzureServiceBusString", + "description": "Azure Service Bus String" + }, + { + "name": "AzureStorageAccountKey", + "value": "AzureStorageAccountKey", + "description": "Azure Storage Account Key" + }, + { + "name": "AzureStorageAccountGeneric", + "value": "AzureStorageAccountGeneric", + "description": "Azure Storage Account Generic" + }, + { + "name": "BENationalNumber", + "value": "BENationalNumber", + "description": "BE National Number" + }, + { + "name": "BENationalNumberV2", + "value": "BENationalNumberV2", + "description": "BE National Number V2" + }, + { + "name": "BEValueAddedTaxNumber", + "value": "BEValueAddedTaxNumber", + "description": "BE Value Added Tax Number" + }, + { + "name": "BRCPFNumber", + "value": "BRCPFNumber", + "description": "BR CPF Number" + }, + { + "name": "BRLegalEntityNumber", + "value": "BRLegalEntityNumber", + "description": "BR Legal Entity Number" + }, + { + "name": "BRNationalIDRG", + "value": "BRNationalIDRG", + "description": "BR National ID RG" + }, + { + "name": "BGUniformCivilNumber", + "value": "BGUniformCivilNumber", + "description": "BG Uniform Civil Number" + }, + { + "name": "CABankAccountNumber", + "value": "CABankAccountNumber", + "description": "CA Bank Account Number" + }, + { + "name": "CADriversLicenseNumber", + "value": "CADriversLicenseNumber", + "description": "CA Driver's License Number" + }, + { + "name": "CAHealthServiceNumber", + "value": "CAHealthServiceNumber", + "description": "CA Health Service Number" + }, + { + "name": "CAPassportNumber", + "value": "CAPassportNumber", + "description": "CA Passport Number" + }, + { + "name": "CAPersonalHealthIdentification", + "value": "CAPersonalHealthIdentification", + "description": "CA Personal Health Identification" + }, + { + "name": "CASocialInsuranceNumber", + "value": "CASocialInsuranceNumber", + "description": "CA Social Insurance Number" + }, + { + "name": "CLIdentityCardNumber", + "value": "CLIdentityCardNumber", + "description": "CL Identity Card Number" + }, + { + "name": "CNResidentIdentityCardNumber", + "value": "CNResidentIdentityCardNumber", + "description": "CN Resident Identity Card Number" + }, + { + "name": "CreditCardNumber", + "value": "CreditCardNumber", + "description": "Credit Card Number" + }, + { + "name": "HRIdentityCardNumber", + "value": "HRIdentityCardNumber", + "description": "HR Identity Card Number" + }, + { + "name": "HRNationalIDNumber", + "value": "HRNationalIDNumber", + "description": "HR National ID Number" + }, + { + "name": "HRPersonalIdentificationNumber", + "value": "HRPersonalIdentificationNumber", + "description": "HR Personal Identification Number" + }, + { + "name": "HRPersonalIdentificationOIBNumberV2", + "value": "HRPersonalIdentificationOIBNumberV2", + "description": "HR Personal Identification OIB Number V2" + }, + { + "name": "CYIdentityCard", + "value": "CYIdentityCard", + "description": "CY Identity Card" + }, + { + "name": "CYTaxIdentificationNumber", + "value": "CYTaxIdentificationNumber", + "description": "CY Tax Identification Number" + }, + { + "name": "CZPersonalIdentityNumber", + "value": "CZPersonalIdentityNumber", + "description": "CZ Personal Identity Number" + }, + { + "name": "CZPersonalIdentityV2", + "value": "CZPersonalIdentityV2", + "description": "CZ Personal Identity V2" + }, + { + "name": "DKPersonalIdentificationNumber", + "value": "DKPersonalIdentificationNumber", + "description": "DK Personal Identification Number" + }, + { + "name": "DKPersonalIdentificationV2", + "value": "DKPersonalIdentificationV2", + "description": "DK Personal Identification V2" + }, + { + "name": "DrugEnforcementAgencyNumber", + "value": "DrugEnforcementAgencyNumber", + "description": "Drug Enforcement Agency Number" + }, + { + "name": "EEPersonalIdentificationCode", + "value": "EEPersonalIdentificationCode", + "description": "EE Personal Identification Code" + }, + { + "name": "EUDebitCardNumber", + "value": "EUDebitCardNumber", + "description": "EU Debit Card Number" + }, + { + "name": "EUDriversLicenseNumber", + "value": "EUDriversLicenseNumber", + "description": "EU Driver's License Number" + }, + { + "name": "EUGPSCoordinates", + "value": "EUGPSCoordinates", + "description": "EU GPS Coordinates" + }, + { + "name": "EUNationalIdentificationNumber", + "value": "EUNationalIdentificationNumber", + "description": "EU National Identification Number" + }, + { + "name": "EUPassportNumber", + "value": "EUPassportNumber", + "description": "EU Passport Number" + }, + { + "name": "EUSocialSecurityNumber", + "value": "EUSocialSecurityNumber", + "description": "EU Social Security Number" + }, + { + "name": "EUTaxIdentificationNumber", + "value": "EUTaxIdentificationNumber", + "description": "EU Tax Identification Number" + }, + { + "name": "FIEuropeanHealthNumber", + "value": "FIEuropeanHealthNumber", + "description": "FI European Health Number" + }, + { + "name": "FINationalID", + "value": "FINationalID", + "description": "FI National ID" + }, + { + "name": "FINationalIDV2", + "value": "FINationalIDV2", + "description": "FI National ID V2" + }, + { + "name": "FIPassportNumber", + "value": "FIPassportNumber", + "description": "FI Passport Number" + }, + { + "name": "FRDriversLicenseNumber", + "value": "FRDriversLicenseNumber", + "description": "FR Driver's License Number" + }, + { + "name": "FRHealthInsuranceNumber", + "value": "FRHealthInsuranceNumber", + "description": "FR Health Insurance Number" + }, + { + "name": "FRNationalID", + "value": "FRNationalID", + "description": "FR National ID" + }, + { + "name": "FRPassportNumber", + "value": "FRPassportNumber", + "description": "FR Passport Number" + }, + { + "name": "FRSocialSecurityNumber", + "value": "FRSocialSecurityNumber", + "description": "FR Social Security Number" + }, + { + "name": "FRTaxIdentificationNumber", + "value": "FRTaxIdentificationNumber", + "description": "FR Tax Identification Number" + }, + { + "name": "FRValueAddedTaxNumber", + "value": "FRValueAddedTaxNumber", + "description": "FR Value Added Tax Number" + }, + { + "name": "DEDriversLicenseNumber", + "value": "DEDriversLicenseNumber", + "description": "DE Driver's License Number" + }, + { + "name": "DEPassportNumber", + "value": "DEPassportNumber", + "description": "DE Passport Number" + }, + { + "name": "DEIdentityCardNumber", + "value": "DEIdentityCardNumber", + "description": "DE Identity Card Number" + }, + { + "name": "DETaxIdentificationNumber", + "value": "DETaxIdentificationNumber", + "description": "DE Tax Identification Number" + }, + { + "name": "DEValueAddedNumber", + "value": "DEValueAddedNumber", + "description": "DE Value Added Number" + }, + { + "name": "GRNationalIDCard", + "value": "GRNationalIDCard", + "description": "GR National ID Card" + }, + { + "name": "GRNationalIDV2", + "value": "GRNationalIDV2", + "description": "GR National ID V2" + }, + { + "name": "GRTaxIdentificationNumber", + "value": "GRTaxIdentificationNumber", + "description": "GR Tax Identification Number" + }, + { + "name": "HKIdentityCardNumber", + "value": "HKIdentityCardNumber", + "description": "HK Identity Card Number" + }, + { + "name": "HUValueAddedNumber", + "value": "HUValueAddedNumber", + "description": "HU Value Added Number" + }, + { + "name": "HUPersonalIdentificationNumber", + "value": "HUPersonalIdentificationNumber", + "description": "HU Personal Identification Number" + }, + { + "name": "HUTaxIdentificationNumber", + "value": "HUTaxIdentificationNumber", + "description": "HU Tax Identification Number" + }, + { + "name": "INPermanentAccount", + "value": "INPermanentAccount", + "description": "IN Permanent Account" + }, + { + "name": "INUniqueIdentificationNumber", + "value": "INUniqueIdentificationNumber", + "description": "IN Unique Identification Number" + }, + { + "name": "IDIdentityCardNumber", + "value": "IDIdentityCardNumber", + "description": "ID Identity Card Number" + }, + { + "name": "InternationalBankingAccountNumber", + "value": "InternationalBankingAccountNumber", + "description": "International Banking Account Number" + }, + { + "name": "IEPersonalPublicServiceNumber", + "value": "IEPersonalPublicServiceNumber", + "description": "IE Personal Public Service Number" + }, + { + "name": "IEPersonalPublicServiceNumberV2", + "value": "IEPersonalPublicServiceNumberV2", + "description": "IE Personal Public Service Number V2" + }, + { + "name": "ILBankAccountNumber", + "value": "ILBankAccountNumber", + "description": "IL Bank Account Number" + }, + { + "name": "ILNationalID", + "value": "ILNationalID", + "description": "IL National ID" + }, + { + "name": "ITDriversLicenseNumber", + "value": "ITDriversLicenseNumber", + "description": "IT Driver's License Number" + }, + { + "name": "ITFiscalCode", + "value": "ITFiscalCode", + "description": "IT Fiscal Code" + }, + { + "name": "ITValueAddedTaxNumber", + "value": "ITValueAddedTaxNumber", + "description": "IT Value Added Tax Number" + }, + { + "name": "JPBankAccountNumber", + "value": "JPBankAccountNumber", + "description": "JP Bank Account Number" + }, + { + "name": "JPDriversLicenseNumber", + "value": "JPDriversLicenseNumber", + "description": "JP Driver's License Number" + }, + { + "name": "JPPassportNumber", + "value": "JPPassportNumber", + "description": "JP Passport Number" + }, + { + "name": "JPResidentRegistrationNumber", + "value": "JPResidentRegistrationNumber", + "description": "JP Resident Registration Number" + }, + { + "name": "JPSocialInsuranceNumber", + "value": "JPSocialInsuranceNumber", + "description": "JP Social Insurance Number" + }, + { + "name": "JPMyNumberCorporate", + "value": "JPMyNumberCorporate", + "description": "JP My Number Corporate" + }, + { + "name": "JPMyNumberPersonal", + "value": "JPMyNumberPersonal", + "description": "JP My Number Personal" + }, + { + "name": "JPResidenceCardNumber", + "value": "JPResidenceCardNumber", + "description": "JP Residence Card Number" + }, + { + "name": "LVPersonalCode", + "value": "LVPersonalCode", + "description": "LV Personal Code" + }, + { + "name": "LTPersonalCode", + "value": "LTPersonalCode", + "description": "LT Personal Code" + }, + { + "name": "LUNationalIdentificationNumberNatural", + "value": "LUNationalIdentificationNumberNatural", + "description": "LU National Identification Number Natural" + }, + { + "name": "LUNationalIdentificationNumberNonNatural", + "value": "LUNationalIdentificationNumberNonNatural", + "description": "LU National Identification Number Non Natural" + }, + { + "name": "MYIdentityCardNumber", + "value": "MYIdentityCardNumber", + "description": "MY Identity Card Number" + }, + { + "name": "MTIdentityCardNumber", + "value": "MTIdentityCardNumber", + "description": "MT Identity Card Number" + }, + { + "name": "MTTaxIDNumber", + "value": "MTTaxIDNumber", + "description": "MT Tax ID Number" + }, + { + "name": "NLCitizensServiceNumber", + "value": "NLCitizensServiceNumber", + "description": "NL Citizens Service Number" + }, + { + "name": "NLCitizensServiceNumberV2", + "value": "NLCitizensServiceNumberV2", + "description": "NL Citizens Service Number V2" + }, + { + "name": "NLTaxIdentificationNumber", + "value": "NLTaxIdentificationNumber", + "description": "NL Tax Identification Number" + }, + { + "name": "NLValueAddedTaxNumber", + "value": "NLValueAddedTaxNumber", + "description": "NL Value Added Tax Number" + }, + { + "name": "NZBankAccountNumber", + "value": "NZBankAccountNumber", + "description": "NZ Bank Account Number" + }, + { + "name": "NZDriversLicenseNumber", + "value": "NZDriversLicenseNumber", + "description": "NZ Driver's License Number" + }, + { + "name": "NZInlandRevenueNumber", + "value": "NZInlandRevenueNumber", + "description": "NZ Inland Revenue Number" + }, + { + "name": "NZMinistryOfHealthNumber", + "value": "NZMinistryOfHealthNumber", + "description": "NZ Ministry Of Health Number" + }, + { + "name": "NZSocialWelfareNumber", + "value": "NZSocialWelfareNumber", + "description": "NZ Social Welfare Number" + }, + { + "name": "NOIdentityNumber", + "value": "NOIdentityNumber", + "description": "NO Identity Number" + }, + { + "name": "PHUnifiedMultiPurposeIDNumber", + "value": "PHUnifiedMultiPurposeIDNumber", + "description": "PH Unified Multi Purpose ID Number" + }, + { + "name": "PLIdentityCard", + "value": "PLIdentityCard", + "description": "PL Identity Card" + }, + { + "name": "PLNationalID", + "value": "PLNationalID", + "description": "PL National ID" + }, + { + "name": "PLNationalIDV2", + "value": "PLNationalIDV2", + "description": "PL National ID V2" + }, + { + "name": "PLPassportNumber", + "value": "PLPassportNumber", + "description": "PL Passport Number" + }, + { + "name": "PLTaxIdentificationNumber", + "value": "PLTaxIdentificationNumber", + "description": "PL Tax Identification Number" + }, + { + "name": "PLREGONNumber", + "value": "PLREGONNumber", + "description": "PL REGON Number" + }, + { + "name": "PTCitizenCardNumber", + "value": "PTCitizenCardNumber", + "description": "PT Citizen Card Number" + }, + { + "name": "PTCitizenCardNumberV2", + "value": "PTCitizenCardNumberV2", + "description": "PT Citizen Card Number V2" + }, + { + "name": "PTTaxIdentificationNumber", + "value": "PTTaxIdentificationNumber", + "description": "PT Tax Identification Number" + }, + { + "name": "ROPersonalNumericalCode", + "value": "ROPersonalNumericalCode", + "description": "RO Personal Numerical Code" + }, + { + "name": "RUPassportNumberDomestic", + "value": "RUPassportNumberDomestic", + "description": "RU Passport Number Domestic" + }, + { + "name": "RUPassportNumberInternational", + "value": "RUPassportNumberInternational", + "description": "RU Passport Number International" + }, + { + "name": "SANationalID", + "value": "SANationalID", + "description": "SA National ID" + }, + { + "name": "SGNationalRegistrationIdentityCardNumber", + "value": "SGNationalRegistrationIdentityCardNumber", + "description": "SG National Registration Identity Card Number" + }, + { + "name": "SKPersonalNumber", + "value": "SKPersonalNumber", + "description": "SK Personal Number" + }, + { + "name": "SITaxIdentificationNumber", + "value": "SITaxIdentificationNumber", + "description": "SI Tax Identification Number" + }, + { + "name": "SIUniqueMasterCitizenNumber", + "value": "SIUniqueMasterCitizenNumber", + "description": "SI Unique Master Citizen Number" + }, + { + "name": "ZAIdentificationNumber", + "value": "ZAIdentificationNumber", + "description": "ZA Identification Number" + }, + { + "name": "KRResidentRegistrationNumber", + "value": "KRResidentRegistrationNumber", + "description": "KR Resident Registration Number" + }, + { + "name": "ESDNI", + "value": "ESDNI", + "description": "ES DNI" + }, + { + "name": "ESSocialSecurityNumber", + "value": "ESSocialSecurityNumber", + "description": "ES Social Security Number" + }, + { + "name": "ESTaxIdentificationNumber", + "value": "ESTaxIdentificationNumber", + "description": "ES Tax Identification Number" + }, + { + "name": "SQLServerConnectionString", + "value": "SQLServerConnectionString", + "description": "SQL Server Connection String" + }, + { + "name": "SENationalID", + "value": "SENationalID", + "description": "SE National ID" + }, + { + "name": "SENationalIDV2", + "value": "SENationalIDV2", + "description": "SE National ID V2" + }, + { + "name": "SEPassportNumber", + "value": "SEPassportNumber", + "description": "SE Passport Number" + }, + { + "name": "SETaxIdentificationNumber", + "value": "SETaxIdentificationNumber", + "description": "SE Tax Identification Number" + }, + { + "name": "SWIFTCode", + "value": "SWIFTCode", + "description": "SWIFT Code" + }, + { + "name": "CHSocialSecurityNumber", + "value": "CHSocialSecurityNumber", + "description": "CH Social Security Number" + }, + { + "name": "TWNationalID", + "value": "TWNationalID", + "description": "TW National ID" + }, + { + "name": "TWPassportNumber", + "value": "TWPassportNumber", + "description": "TW Passport Number" + }, + { + "name": "TWResidentCertificate", + "value": "TWResidentCertificate", + "description": "TW Resident Certificate" + }, + { + "name": "THPopulationIdentificationCode", + "value": "THPopulationIdentificationCode", + "description": "TH Population Identification Code" + }, + { + "name": "TRNationalIdentificationNumber", + "value": "TRNationalIdentificationNumber", + "description": "TR National Identification Number" + }, + { + "name": "UKDriversLicenseNumber", + "value": "UKDriversLicenseNumber", + "description": "UK Driver's License Number" + }, + { + "name": "UKElectoralRollNumber", + "value": "UKElectoralRollNumber", + "description": "UK Electoral Roll Number" + }, + { + "name": "UKNationalHealthNumber", + "value": "UKNationalHealthNumber", + "description": "UK National Health Number" + }, + { + "name": "UKNationalInsuranceNumber", + "value": "UKNationalInsuranceNumber", + "description": "UK National Insurance Number" + }, + { + "name": "UKUniqueTaxpayerNumber", + "value": "UKUniqueTaxpayerNumber", + "description": "UK Unique Taxpayer Number" + }, + { + "name": "USUKPassportNumber", + "value": "USUKPassportNumber", + "description": "US UK Passport Number" + }, + { + "name": "USBankAccountNumber", + "value": "USBankAccountNumber", + "description": "US Bank Account Number" + }, + { + "name": "USDriversLicenseNumber", + "value": "USDriversLicenseNumber", + "description": "US Driver's License Number" + }, + { + "name": "USIndividualTaxpayerIdentification", + "value": "USIndividualTaxpayerIdentification", + "description": "US Individual Taxpayer Identification" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US Social Security Number" + }, + { + "name": "UAPassportNumberDomestic", + "value": "UAPassportNumberDomestic", + "description": "UA Passport Number Domestic" + }, + { + "name": "UAPassportNumberInternational", + "value": "UAPassportNumberInternational", + "description": "UA Passport Number International" + }, + { + "name": "Organization", + "value": "Organization", + "description": "Organization" + }, + { + "name": "Email", + "value": "Email", + "description": "Email" + }, + { + "name": "URL", + "value": "URL", + "description": "URL" + }, + { + "name": "Age", + "value": "Age", + "description": "Age" + }, + { + "name": "PhoneNumber", + "value": "PhoneNumber", + "description": "Phone Number" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "IP Address" + }, + { + "name": "Date", + "value": "Date", + "description": "Date" + }, + { + "name": "Person", + "value": "Person", + "description": "Person" + }, + { + "name": "Address", + "value": "Address", + "description": "Address" + }, + { + "name": "All", + "value": "All", + "description": "All PII categories." + }, + { + "name": "Default", + "value": "Default", + "description": "Default PII categories for the language." + } + ] + } + }, + "PiiEntityRecognitionLROResult": { + "type": "object", + "description": "Contains the PII LRO results.", + "properties": { + "results": { + "$ref": "#/definitions/AnalyzeDocumentsResult", + "description": "The list of pii document results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeDocumentsLROResult" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" + }, + "PiiLROTask": { + "type": "object", + "description": "Contains the analyze text PIIEntityRecognition LRO task.", + "properties": { + "parameters": { + "$ref": "#/definitions/PiiTaskParameters", + "description": "Pii task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeDocumentsLROTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "PiiTaskParameters": { + "type": "object", + "description": "Supported parameters for a PII Entities Recognition task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "domain": { + "type": "string", + "description": "Domain for PII task", + "default": "none", + "enum": [ + "phi", + "none" + ], + "x-ms-enum": { + "name": "PiiDomain", + "modelAsString": true, + "values": [ + { + "name": "phi", + "value": "phi", + "description": "Indicates that entities in the Personal Health Information domain should be redacted." + }, + { + "name": "none", + "value": "none", + "description": "Indicates that no domain is specified." + } + ] + } + }, + "piiCategories": { + "type": "array", + "description": "Enumeration of PII categories to be returned in the response.", + "items": { + "$ref": "#/definitions/PiiCategory" + } }, "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" + "type": "string", + "description": "StringIndexType to be used for analysis.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to textElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "excludePiiCategories": { + "type": "array", + "description": "Enumeration of PII categories to be excluded in the response.", + "items": { + "$ref": "#/definitions/PiiCategoriesExclude" + } }, "redactionCharacter": { - "$ref": "#/definitions/RedactionCharacter" + "type": "string", + "description": "Character to be used for redaction. Default in '*'.", + "default": "*", + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ], + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true, + "values": [ + { + "name": "exclamationPoint", + "value": "!", + "description": "Exclamation point character" + }, + { + "name": "numberSign", + "value": "#", + "description": "Number sign character" + }, + { + "name": "dollar", + "value": "$", + "description": "Dollar sign character" + }, + { + "name": "perCent", + "value": "%", + "description": "Percent sign character" + }, + { + "name": "ampersand", + "value": "&", + "description": "Ampersand character" + }, + { + "name": "asterisk", + "value": "*", + "description": "Asterisk character" + }, + { + "name": "plus", + "value": "+", + "description": "Plus sign character" + }, + { + "name": "minus", + "value": "-", + "description": "Minus sign character" + }, + { + "name": "equals", + "value": "=", + "description": "Equals sign character" + }, + { + "name": "questionMark", + "value": "?", + "description": "Question mark character" + }, + { + "name": "atSign", + "value": "@", + "description": "At sign character" + }, + { + "name": "caret", + "value": "^", + "description": "Caret character" + }, + { + "name": "underscore", + "value": "_", + "description": "Underscore character" + }, + { + "name": "tilde", + "value": "~", + "description": "Tilde character" + } + ] + } } - }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + }, + "RequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the request payload.", + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." } + }, + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" ] }, - "PiiDomain": { + "ScriptCode": { + "type": "string", + "description": "Identifies the script of the input document. Maps to the ISO 15924 standard script code.", + "enum": [ + "Arab", + "Armn", + "Beng", + "Cans", + "Cyrl", + "Deva", + "Ethi", + "Geor", + "Grek", + "Gujr", + "Guru", + "Hang", + "Hans", + "Hant", + "Hebr", + "Jpan", + "Khmr", + "Knda", + "Laoo", + "Latn", + "Mlym", + "Mymr", + "Orya", + "Sinh", + "Taml", + "Telu", + "Thaa", + "Thai", + "Tibt" + ], + "x-ms-enum": { + "name": "ScriptCode", + "modelAsString": true, + "values": [ + { + "name": "Arab", + "value": "Arab", + "description": "Script code for the Arabic script." + }, + { + "name": "Armn", + "value": "Armn", + "description": "Script code for the Armenian script." + }, + { + "name": "Beng", + "value": "Beng", + "description": "Script code for the Bangla script." + }, + { + "name": "Cans", + "value": "Cans", + "description": "Script code for the UnifiedCanadianAboriginalSyllabics script." + }, + { + "name": "Cyrl", + "value": "Cyrl", + "description": "Script code for the Cyrillic script." + }, + { + "name": "Deva", + "value": "Deva", + "description": "Script code for the Devanagari script." + }, + { + "name": "Ethi", + "value": "Ethi", + "description": "Script code for the Ethiopic script." + }, + { + "name": "Geor", + "value": "Geor", + "description": "Script code for the Georgian script." + }, + { + "name": "Grek", + "value": "Grek", + "description": "Script code for the Greek script." + }, + { + "name": "Gujr", + "value": "Gujr", + "description": "Script code for the Gujarati script." + }, + { + "name": "Guru", + "value": "Guru", + "description": "Script code for the Gurmukhi script." + }, + { + "name": "Hang", + "value": "Hang", + "description": "Script code for the Hangul script." + }, + { + "name": "Hans", + "value": "Hans", + "description": "Script code for the HanSimplified script." + }, + { + "name": "Hant", + "value": "Hant", + "description": "Script code for the HanTraditional script." + }, + { + "name": "Hebr", + "value": "Hebr", + "description": "Script code for the Hebrew script." + }, + { + "name": "Jpan", + "value": "Jpan", + "description": "Script code for the Japanese script." + }, + { + "name": "Khmr", + "value": "Khmr", + "description": "Script code for the Khmer script." + }, + { + "name": "Knda", + "value": "Knda", + "description": "Script code for the Kannada script." + }, + { + "name": "Laoo", + "value": "Laoo", + "description": "Script code for the Lao script." + }, + { + "name": "Latn", + "value": "Latn", + "description": "Script code for the Latin script." + }, + { + "name": "Mlym", + "value": "Mlym", + "description": "Script code for the Malayalam script." + }, + { + "name": "Mymr", + "value": "Mymr", + "description": "Script code for the Myanmar script." + }, + { + "name": "Orya", + "value": "Orya", + "description": "Script code for the Odia script." + }, + { + "name": "Sinh", + "value": "Sinh", + "description": "Script code for the Sinhala script." + }, + { + "name": "Taml", + "value": "Taml", + "description": "Script code for the Tamil script." + }, + { + "name": "Telu", + "value": "Telu", + "description": "Script code for the Telugu script." + }, + { + "name": "Thaa", + "value": "Thaa", + "description": "Script code for the Thaana script." + }, + { + "name": "Thai", + "value": "Thai", + "description": "Script code for the Thai script." + }, + { + "name": "Tibt", + "value": "Tibt", + "description": "Script code for the Tibetan script." + } + ] + } + }, + "ScriptKind": { + "type": "string", + "description": "The script of the text.", + "enum": [ + "Arabic", + "Armenian", + "Bangla", + "UnifiedCanadianAboriginalSyllabics", + "Cyrillic", + "Devanagari", + "Ethiopic", + "Georgian", + "Greek", + "Gujarati", + "Gurmukhi", + "Hangul", + "HanSimplified", + "HanTraditional", + "Hebrew", + "Japanese", + "Khmer", + "Kannada", + "Lao", + "Latin", + "Malayalam", + "Myanmar", + "Odia", + "Sinhala", + "Tamil", + "Telugu", + "Thaana", + "Thai", + "Tibetan" + ], + "x-ms-enum": { + "name": "ScriptKind", + "modelAsString": true, + "values": [ + { + "name": "Arabic", + "value": "Arabic", + "description": "Script name for the Arabic script." + }, + { + "name": "Armenian", + "value": "Armenian", + "description": "Script name for the Armenian script." + }, + { + "name": "Bangla", + "value": "Bangla", + "description": "Script name for the Bangla script." + }, + { + "name": "UnifiedCanadianAboriginalSyllabics", + "value": "UnifiedCanadianAboriginalSyllabics", + "description": "Script name for the UnifiedCanadianAboriginalSyllabics script." + }, + { + "name": "Cyrillic", + "value": "Cyrillic", + "description": "Script name for the Cyrillic script." + }, + { + "name": "Devanagari", + "value": "Devanagari", + "description": "Script name for the Devanagari script." + }, + { + "name": "Ethiopic", + "value": "Ethiopic", + "description": "Script name for the Ethiopic script." + }, + { + "name": "Georgian", + "value": "Georgian", + "description": "Script name for the Georgian script." + }, + { + "name": "Greek", + "value": "Greek", + "description": "Script name for the Greek script." + }, + { + "name": "Gujarati", + "value": "Gujarati", + "description": "Script name for the Gujarati script." + }, + { + "name": "Gurmukhi", + "value": "Gurmukhi", + "description": "Script name for the Gurmukhi script." + }, + { + "name": "Hangul", + "value": "Hangul", + "description": "Script name for the Hangul script." + }, + { + "name": "HanSimplified", + "value": "HanSimplified", + "description": "Script name for the HanSimplified script." + }, + { + "name": "HanTraditional", + "value": "HanTraditional", + "description": "Script name for the HanTraditional script." + }, + { + "name": "Hebrew", + "value": "Hebrew", + "description": "Script name for the Hebrew script." + }, + { + "name": "Japanese", + "value": "Japanese", + "description": "Script name for the Japanese script." + }, + { + "name": "Khmer", + "value": "Khmer", + "description": "Script name for the Khmer script." + }, + { + "name": "Kannada", + "value": "Kannada", + "description": "Script name for the Kannada script." + }, + { + "name": "Lao", + "value": "Lao", + "description": "Script name for the Lao script." + }, + { + "name": "Latin", + "value": "Latin", + "description": "Script name for the Latin script." + }, + { + "name": "Malayalam", + "value": "Malayalam", + "description": "Script name for the Malayalam script." + }, + { + "name": "Myanmar", + "value": "Myanmar", + "description": "Script name for the Myanmar script." + }, + { + "name": "Odia", + "value": "Odia", + "description": "Script name for the Odia script." + }, + { + "name": "Sinhala", + "value": "Sinhala", + "description": "Script name for the Sinhala script." + }, + { + "name": "Tamil", + "value": "Tamil", + "description": "Script name for the Tamil script." + }, + { + "name": "Telugu", + "value": "Telugu", + "description": "Script name for the Telugu script." + }, + { + "name": "Thaana", + "value": "Thaana", + "description": "Script name for the Thaana script." + }, + { + "name": "Thai", + "value": "Thai", + "description": "Script name for the Thai script." + }, + { + "name": "Tibetan", + "value": "Tibetan", + "description": "Script name for the Tibetan script." + } + ] + } + }, + "State": { "type": "string", - "description": "The PII domain used for PII Entity Recognition.", - "default": "none", + "description": "The status of the task at the mentioned last update time.", "enum": [ - "phi", - "none" + "notStarted", + "running", + "succeeded", + "partiallyCompleted", + "failed", + "cancelled", + "cancelling" ], "x-ms-enum": { - "name": "PiiDomain", + "name": "State", "modelAsString": true, "values": [ { - "name": "phi", - "description": "Indicates that entities in the Personal Health Information domain should be redacted.", - "value": "phi" + "name": "notStarted", + "value": "notStarted", + "description": "Not started status" + }, + { + "name": "running", + "value": "running", + "description": "Running status" + }, + { + "name": "succeeded", + "value": "succeeded", + "description": "Succeeded status" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted", + "description": "Partially completed status" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed status" + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Cancelled status" }, { - "name": "none", - "description": "Indicates that no domain is specified.", - "value": "none" + "name": "cancelling", + "value": "cancelling", + "description": "Cancelling status" } ] } }, - "piiCategories": { - "type": "array", - "description": "Enumeration of PII categories to be returned in the response.", - "items": { - "$ref": "#/definitions/PiiCategory" - } - }, - "PiiCategoriesExclude": { - "description": "(Optional) describes the PII categories to return", - "items": { - "type": "string", - "x-ms-enum": { - "name": "PiiCategoriesExclude", - "modelAsString": true - }, - "enum": [ - "ABARoutingNumber", - "ARNationalIdentityNumber", - "AUBankAccountNumber", - "AUDriversLicenseNumber", - "AUMedicalAccountNumber", - "AUPassportNumber", - "AUTaxFileNumber", - "AUBusinessNumber", - "AUCompanyNumber", - "ATIdentityCard", - "ATTaxIdentificationNumber", - "ATValueAddedTaxNumber", - "AzureDocumentDBAuthKey", - "AzureIAASDatabaseConnectionAndSQLString", - "AzureIoTConnectionString", - "AzurePublishSettingPassword", - "AzureRedisCacheString", - "AzureSAS", - "AzureServiceBusString", - "AzureStorageAccountKey", - "AzureStorageAccountGeneric", - "BENationalNumber", - "BENationalNumberV2", - "BEValueAddedTaxNumber", - "BRCPFNumber", - "BRLegalEntityNumber", - "BRNationalIDRG", - "BGUniformCivilNumber", - "CABankAccountNumber", - "CADriversLicenseNumber", - "CAHealthServiceNumber", - "CAPassportNumber", - "CAPersonalHealthIdentification", - "CASocialInsuranceNumber", - "CLIdentityCardNumber", - "CNResidentIdentityCardNumber", - "CreditCardNumber", - "HRIdentityCardNumber", - "HRNationalIDNumber", - "HRPersonalIdentificationNumber", - "HRPersonalIdentificationOIBNumberV2", - "CYIdentityCard", - "CYTaxIdentificationNumber", - "CZPersonalIdentityNumber", - "CZPersonalIdentityV2", - "DKPersonalIdentificationNumber", - "DKPersonalIdentificationV2", - "DrugEnforcementAgencyNumber", - "EEPersonalIdentificationCode", - "EUDebitCardNumber", - "EUDriversLicenseNumber", - "EUGPSCoordinates", - "EUNationalIdentificationNumber", - "EUPassportNumber", - "EUSocialSecurityNumber", - "EUTaxIdentificationNumber", - "FIEuropeanHealthNumber", - "FINationalID", - "FINationalIDV2", - "FIPassportNumber", - "FRDriversLicenseNumber", - "FRHealthInsuranceNumber", - "FRNationalID", - "FRPassportNumber", - "FRSocialSecurityNumber", - "FRTaxIdentificationNumber", - "FRValueAddedTaxNumber", - "DEDriversLicenseNumber", - "DEPassportNumber", - "DEIdentityCardNumber", - "DETaxIdentificationNumber", - "DEValueAddedNumber", - "GRNationalIDCard", - "GRNationalIDV2", - "GRTaxIdentificationNumber", - "HKIdentityCardNumber", - "HUValueAddedNumber", - "HUPersonalIdentificationNumber", - "HUTaxIdentificationNumber", - "INPermanentAccount", - "INUniqueIdentificationNumber", - "IDIdentityCardNumber", - "InternationalBankingAccountNumber", - "IEPersonalPublicServiceNumber", - "IEPersonalPublicServiceNumberV2", - "ILBankAccountNumber", - "ILNationalID", - "ITDriversLicenseNumber", - "ITFiscalCode", - "ITValueAddedTaxNumber", - "JPBankAccountNumber", - "JPDriversLicenseNumber", - "JPPassportNumber", - "JPResidentRegistrationNumber", - "JPSocialInsuranceNumber", - "JPMyNumberCorporate", - "JPMyNumberPersonal", - "JPResidenceCardNumber", - "LVPersonalCode", - "LTPersonalCode", - "LUNationalIdentificationNumberNatural", - "LUNationalIdentificationNumberNonNatural", - "MYIdentityCardNumber", - "MTIdentityCardNumber", - "MTTaxIDNumber", - "NLCitizensServiceNumber", - "NLCitizensServiceNumberV2", - "NLTaxIdentificationNumber", - "NLValueAddedTaxNumber", - "NZBankAccountNumber", - "NZDriversLicenseNumber", - "NZInlandRevenueNumber", - "NZMinistryOfHealthNumber", - "NZSocialWelfareNumber", - "NOIdentityNumber", - "PHUnifiedMultiPurposeIDNumber", - "PLIdentityCard", - "PLNationalID", - "PLNationalIDV2", - "PLPassportNumber", - "PLTaxIdentificationNumber", - "PLREGONNumber", - "PTCitizenCardNumber", - "PTCitizenCardNumberV2", - "PTTaxIdentificationNumber", - "ROPersonalNumericalCode", - "RUPassportNumberDomestic", - "RUPassportNumberInternational", - "SANationalID", - "SGNationalRegistrationIdentityCardNumber", - "SKPersonalNumber", - "SITaxIdentificationNumber", - "SIUniqueMasterCitizenNumber", - "ZAIdentificationNumber", - "KRResidentRegistrationNumber", - "ESDNI", - "ESSocialSecurityNumber", - "ESTaxIdentificationNumber", - "SQLServerConnectionString", - "SENationalID", - "SENationalIDV2", - "SEPassportNumber", - "SETaxIdentificationNumber", - "SWIFTCode", - "CHSocialSecurityNumber", - "TWNationalID", - "TWPassportNumber", - "TWResidentCertificate", - "THPopulationIdentificationCode", - "TRNationalIdentificationNumber", - "UKDriversLicenseNumber", - "UKElectoralRollNumber", - "UKNationalHealthNumber", - "UKNationalInsuranceNumber", - "UKUniqueTaxpayerNumber", - "USUKPassportNumber", - "USBankAccountNumber", - "USDriversLicenseNumber", - "USIndividualTaxpayerIdentification", - "USSocialSecurityNumber", - "UAPassportNumberDomestic", - "UAPassportNumberInternational", - "Organization", - "Email", - "URL", - "Age", - "PhoneNumber", - "IPAddress", - "Date", - "Person", - "Address" - ] - }, - "type": "array", - "uniqueItems": true - }, - "PiiEntitiesDocumentResult": { - "type": "object", - "properties": { - "redactedText": { - "type": "string", - "description": "Returns redacted text." - }, - "entities": { - "type": "array", - "description": "Recognized entities in the document.", - "items": { - "$ref": "#/definitions/Entity" - } - } - }, - "required": [ - "redactedText", - "entities" - ] - }, - "Entity": { + "SummaryContext": { "type": "object", - "required": [ - "text", - "category", - "offset", - "length", - "confidenceScore" - ], + "description": "The context of the summary.", "properties": { - "text": { - "type": "string", - "description": "Entity text as appears in the request." - }, - "category": { - "type": "string", - "description": "Entity type." - }, - "subcategory": { - "type": "string", - "description": "(Optional) Entity sub type." - }, "offset": { "type": "integer", "format": "int32", - "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." }, "length": { "type": "integer", "format": "int32", - "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score between 0 and 1 of the extracted entity." - } - } - }, - "ExtractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Extractive Summarization task.", - "properties": { - "parameters": { - "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeDocumentsLROTask" - } - ], - "x-ms-discriminator-value": "ExtractiveSummarization" - }, - "ExtractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for an Extractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "default": 3, - "format": "int64" - }, - "sortBy": { - "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" + "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." } }, - "allOf": [ - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } + "required": [ + "offset", + "length" ] }, - "ExtractiveSummarizationSortingCriteria": { + "SummaryLengthBucket": { "type": "string", - "default": "Offset", - "description": "The sorting criteria to use for the results of Extractive Summarization.", + "description": "Enum that defines the length of the output summaries.", "enum": [ - "Offset", - "Rank" + "short", + "medium", + "long" ], "x-ms-enum": { - "name": "ExtractiveSummarizationSortingCriteria", + "name": "SummaryLengthBucket", "modelAsString": true, "values": [ { - "name": "Offset", - "description": "Indicates that results should be sorted in order of appearance in the text.", - "value": "Offset" + "name": "short", + "value": "short", + "description": "Instructs model to generate shorter length summaries." + }, + { + "name": "medium", + "value": "medium", + "description": "Instructs model to generate medium length summaries." }, { - "name": "Rank", - "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", - "value": "Rank" + "name": "long", + "value": "long", + "description": "Instructs model to generate longer length summaries." } ] } }, - "ExtractedSummaryDocumentResult": { - "type": "object", - "properties": { - "sentences": { - "type": "array", - "description": "A ranked list of sentences representing the extracted summary.", - "items": { - "$ref": "#/definitions/ExtractedSummarySentence" - } - } - }, - "required": [ - "sentences" - ] - }, - "ExtractedSummarySentence": { + "Tasks": { "type": "object", - "required": [ - "text", - "rankScore", - "offset", - "length" - ], + "description": "Container for the tasks status for the LRO job.", "properties": { - "text": { - "type": "string", - "description": "The extracted sentence text." - }, - "rankScore": { - "type": "number", - "format": "double", - "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." + "completed": { + "type": "integer", + "format": "int32", + "description": "Count of completed tasks." }, - "offset": { + "failed": { "type": "integer", "format": "int32", - "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." + "description": "Count of failed tasks." }, - "length": { + "inProgress": { "type": "integer", "format": "int32", - "description": "The length of the sentence." - } - } - }, - "AbstractiveSummarizationLROTask": { - "type": "object", - "description": "An object representing the task definition for an Abstractive Summarization task.", - "required": [ - "parameters" - ], - "properties": { - "parameters": { - "$ref": "#/definitions/AbstractiveSummarizationTaskParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AnalyzeDocumentsLROTask" - } - ], - "x-ms-discriminator-value": "AbstractiveSummarization" - }, - "AbstractiveSummarizationTaskParameters": { - "type": "object", - "description": "Supported parameters for the pre-build Abstractive Summarization task.", - "allOf": [ - { - "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" + "description": "Count of inprogress tasks." }, - { - "$ref": "common.json#/definitions/PreBuiltTaskParameters" - } - ] - }, - "AbstractiveSummaryDocumentResult": { - "type": "object", - "description": "An object representing the summarization result of a single document.", - "properties": { - "summaries": { - "type": "array", - "description": "A list of abstractive summaries.", - "items": { - "$ref": "#/definitions/AbstractiveSummary" - } - } - }, - "required": [ - "summaries" - ] - }, - "AbstractiveSummary": { - "type": "object", - "description": "An object representing a single summary with context for given document.", - "properties": { - "text": { - "type": "string", - "description": "The text of the summary." + "total": { + "type": "integer", + "format": "int32", + "description": "Count of total tasks." }, - "contexts": { + "items": { "type": "array", - "description": "The context list of the summary.", + "description": "Enumerable of Analyze documents job results.", "items": { - "$ref": "common.json#/definitions/SummaryContext" - } + "$ref": "#/definitions/AnalyzeDocumentsLROResult" + }, + "x-ms-identifiers": [] } }, "required": [ - "text" + "completed", + "failed", + "inProgress", + "total" ] }, - "Language": { - "type": "string", - "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." - }, - "RedactionCharacter": { + "WarningCodeValue": { "type": "string", - "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.", - "default": "*", - "x-ms-enum": { - "name": "redactionCharacter", - "modelAsString": true - }, + "description": "Defines the list of the warning codes.", "enum": [ - "!", - "#", - "$", - "%", - "&", - "*", - "+", - "-", - "=", - "?", - "@", - "^", - "_", - "~" - ] - }, - "TaskIdentifier": { - "type": "object", - "description": "Base task object.", - "properties": { - "taskName": { - "type": "string" - } - } - }, - "TaskParameters": { - "type": "object", - "description": "Base parameters object for a text analysis task.", - "properties": { - "loggingOptOut": { - "type": "boolean", - "default": false - } - } - }, - "AbstractiveSummarizationTaskParametersBase": { - "type": "object", - "description": "Supported parameters for an Abstractive Summarization task.", - "properties": { - "sentenceCount": { - "type": "integer", - "format": "int32", - "description": "It controls the approximate number of sentences in the output summaries." - }, - "stringIndexType": { - "$ref": "common.json#/definitions/StringIndexType" - } - } - }, - "SummaryContext": { - "type": "object", - "description": "The context of the summary.", - "required": [ - "offset", - "length" + "LongWordsInDocument", + "DocumentTruncated" ], - "properties": { - "offset": { - "type": "integer", - "format": "int32", - "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." - } + "x-ms-enum": { + "name": "WarningCodeValue", + "modelAsString": true, + "values": [ + { + "name": "LongWordsInDocument", + "value": "LongWordsInDocument", + "description": "Long words in document warning" + }, + { + "name": "DocumentTruncated", + "value": "DocumentTruncated", + "description": "Document truncated warning" + } + ] } } }, "parameters": { - "ShowStats": { - "name": "showStats", + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", "in": "query", - "description": "(Optional) if set to true, response will contain request and document level statistics.", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - }, - "JobId": { - "description": "Job ID", - "format": "uuid", - "in": "path", - "name": "jobId", + "description": "The API version to use for this operation.", "required": true, "type": "string", - "x-ms-parameter-location": "method" + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json new file mode 100644 index 000000000000..ec80f4e88385 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json @@ -0,0 +1,61 @@ +{ + "operationId": "AnalyzeDocumentsJobStatus", + "title": "SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2023-12-30T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2023-12-30T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "items": [ + { + "kind": "PiiEntityRecognitionLROResults", + "taskName": "PII Redaction Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "source": { + "location": "https://myblob.blob.core.windows.net/Container/document.txt", + "kind": "AzureBlob" + }, + "target": [ + { + "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545/PiiEntityRecognition/1/document.txt", + "kind": "AzureBlob" + }, + { + "location": "https://myblob.blob.core.windows.net/Container/0af5def0-5855-41b2-9e75-0a559fb6f545/PiiEntityRecognition/1/document.json", + "kind": "AzureBlob" + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-09-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsCancelRequest.json new file mode 100644 index 000000000000..9731ac566fc4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsCancelRequest.json @@ -0,0 +1,17 @@ +{ + "operationId": "AnalyzeDocumentsCancelJob", + "title": "SuccessfulAnalyzeDocumentsJobsCancelRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json new file mode 100644 index 000000000000..44d556929d7d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json @@ -0,0 +1,50 @@ +{ + "operationId": "AnalyzeDocumentsSubmitJob", + "title": "SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Redact PII Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "source": { + "location": "https://myblob.blob.core.windows.net/Container/document.txt", + "kind": "AzureBlob", + "managedIdentityClientId": "edaa610c-d7e8-4ba2-823a-97d871d661fb" + }, + "target": { + "location": "https://myblob.blob.core.windows.net/Container", + "kind": "AzureBlob" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "taskName": "Redact PII Task 1", + "parameters": { + "redactionCharacter": "-", + "piiCategories": [ + "Person", + "Organization" + ] + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index b0228dc580fe..b05cc22bef77 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -55,11 +55,11 @@ These settings apply only when `--tag=release_2023_11_15_preview` is specified o ``` yaml $(tag) == 'release_2023-11-15-preview' input-file: - - preview/2023-11-15-preview/analyzedocuments.json - preview/2023-11-15-preview/analyzetext.json - preview/2023-11-15-preview/analyzetext-authoring.json - preview/2023-11-15-preview/analyzeconversations.json - preview/2023-11-15-preview/analyzeconversations-authoring.json + - preview/2023-11-15-preview/analyzedocuments.json - preview/2023-11-15-preview/questionanswering.json - preview/2023-11-15-preview/questionanswering-authoring.json title: From b48f1661e37886acd91b9c797873b757e7f2b6fc Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 28 Aug 2024 12:46:35 -0700 Subject: [PATCH 21/30] Add check blocking PRs to protected files (e.g. package.json) (#30349) - Fixes #25144 --- .github/workflows/protected-files.yaml | 38 ++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/protected-files.yaml diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml new file mode 100644 index 000000000000..c03722ace739 --- /dev/null +++ b/.github/workflows/protected-files.yaml @@ -0,0 +1,38 @@ +name: Protected Files + +on: + pull_request: + branches: + - main + - RPSaaSMaster + +jobs: + protected-files: + name: Protected Files + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + # Required since "HEAD^" is passed to Get-ChangedFiles + fetch-depth: 2 + + - name: Detect changes to protected files + run: | + . eng/scripts/ChangedFiles-Functions.ps1 + + $protectedFiles = @("package.json", "package-lock.json") + $changedFiles = @(Get-ChangedFiles -baseCommitish HEAD^ -targetCommitish HEAD -diffFilter "") + $matchedFiles = @($protectedFiles | Where-Object { $changedFiles -contains $_}) + + if ($matchedFiles.Count -gt 0) { + foreach ($file in $matchedFiles) { + Write-Output "::error file=$file::File '$file' should only be updated by the Azure SDK team. If intentional, the PR may be merged by the Azure SDK team via bypassing the branch protections." + } + exit 1 + } + else { + Write-Output "::notice::No changes to protected files: [$($protectedFiles -join ', ')]" + } + shell: pwsh From e19b5771846718774c0452800b9a42c251319f48 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 28 Aug 2024 13:07:32 -0700 Subject: [PATCH 22/30] [Protected Files] Run check on all branches (#30362) - Only required in GH settings on main and RPSaaSMaster --- .github/workflows/protected-files.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index c03722ace739..4a62b43291e6 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -1,10 +1,6 @@ name: Protected Files -on: - pull_request: - branches: - - main - - RPSaaSMaster +on: pull_request jobs: protected-files: From 31632cb7852bbef83b3f35068143d5817cbf44e6 Mon Sep 17 00:00:00 2001 From: Mark Cowlishaw Date: Wed, 28 Aug 2024 16:49:39 -0700 Subject: [PATCH 23/30] Update specs for no record check (#30363) --- .../Workloads.SAPVirtualInstance.Management/models.tsp | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp index 06985787cb05..fe6eabe6655b 100644 --- a/specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/models.tsp @@ -709,6 +709,7 @@ model SAPDiskConfigurationsResult { /** * The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup']. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" volumeConfigurations?: Record; } @@ -1008,6 +1009,7 @@ model UpdateSAPVirtualInstanceRequest { /** * Gets or sets the Resource tags. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" tags?: Record; /** @@ -1313,6 +1315,7 @@ model UpdateSAPCentralInstanceRequest { /** * Gets or sets the Resource tags. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" tags?: Record; } @@ -1409,6 +1412,7 @@ model UpdateSAPDatabaseInstanceRequest { /** * Gets or sets the Resource tags. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" tags?: Record; } @@ -1547,6 +1551,7 @@ model UpdateSAPApplicationInstanceRequest { /** * Gets or sets the Resource tags. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" tags?: Record; } @@ -1771,6 +1776,7 @@ model DiskConfiguration { /** * The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup']. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" diskVolumeConfigurations?: Record; } @@ -2121,6 +2127,7 @@ model VirtualMachineResourceNames { /** * The full resource names for virtual machine data disks. This is a dictionary containing list of names of data disks per volume. Currently supported volumes for database layer are ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os', 'backup']. For application and cs layers, only 'default' volume is supported */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" dataDiskNames?: Record; } From a3d10ee17c8f7ca4c2b4402862a1dc78fbab5c2a Mon Sep 17 00:00:00 2001 From: Shreya Anand Date: Thu, 29 Aug 2024 11:26:34 +0530 Subject: [PATCH 24/30] Release playwrighttesting microsoft.playwright testing preview/2024 08 01 preview (#30356) * base commit to add new version folder * new arm api version * swagger validation fix --------- Co-authored-by: Nikhil Gupta <52026487+nikhgup@users.noreply.github.com> --- .../AccountQuotas_Get.json | 2 +- .../AccountQuotas_ListByAccount.json | 17 +- .../Accounts_CheckNameAvailability.json | 2 +- .../Accounts_CreateOrUpdate.json | 8 +- .../Accounts_Delete.json | 5 +- .../Accounts_Get.json | 5 +- .../Accounts_ListByResourceGroup.json | 5 +- .../Accounts_ListBySubscription.json | 5 +- .../Accounts_Update.json | 5 +- .../Operations_List.json | 2 +- .../Quotas_Get.json | 3 +- .../Quotas_ListBySubscription.json | 16 +- .../PlaywrightTesting.Management/main.tsp | 43 +- .../tspconfig.yaml | 1 + .../examples/AccountQuotas_Get.json | 30 + .../examples/AccountQuotas_ListByAccount.json | 48 + .../Accounts_CheckNameAvailability.json | 20 + .../examples/Accounts_CreateOrUpdate.json | 78 ++ .../examples/Accounts_Delete.json | 18 + .../examples/Accounts_Get.json | 39 + .../Accounts_ListByResourceGroup.json | 42 + .../examples/Accounts_ListBySubscription.json | 41 + .../examples/Accounts_Update.json | 48 + .../examples/Operations_List.json | 46 + .../examples/Quotas_Get.json | 27 + .../examples/Quotas_ListBySubscription.json | 43 + .../2024-08-01-preview/playwrighttesting.json | 1219 +++++++++++++++++ .../resource-manager/readme.md | 28 +- 28 files changed, 1822 insertions(+), 24 deletions(-) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/AccountQuotas_Get.json (95%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/AccountQuotas_ListByAccount.json (59%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Accounts_CheckNameAvailability.json (91%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Accounts_CreateOrUpdate.json (93%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Accounts_Delete.json (89%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Accounts_Get.json (91%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Accounts_ListByResourceGroup.json (91%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Accounts_ListBySubscription.json (91%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Accounts_Update.json (92%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Operations_List.json (97%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Quotas_Get.json (89%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{2024-02-01-preview => 2024-08-01-preview}/Quotas_ListBySubscription.json (55%) create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_Get.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_ListByAccount.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CheckNameAvailability.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Delete.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Get.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListByResourceGroup.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListBySubscription.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Update.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Operations_List.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_Get.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_ListBySubscription.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/playwrighttesting.json diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_Get.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/AccountQuotas_Get.json similarity index 95% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_Get.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/AccountQuotas_Get.json index 3f9210fcd2ea..96a9c6e6d1f0 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_Get.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/AccountQuotas_Get.json @@ -2,7 +2,7 @@ "title": "AccountQuotas_Get", "operationId": "AccountQuotas_Get", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", "accountName": "myPlaywrightAccount", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_ListByAccount.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/AccountQuotas_ListByAccount.json similarity index 59% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_ListByAccount.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/AccountQuotas_ListByAccount.json index b04ddf4c8a59..4a10a56c6c8b 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_ListByAccount.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/AccountQuotas_ListByAccount.json @@ -2,7 +2,7 @@ "title": "AccountQuotas_ListByAccount", "operationId": "AccountQuotas_ListByAccount", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", "accountName": "myPlaywrightAccount" @@ -25,6 +25,21 @@ }, "provisioningState": "Succeeded" } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/Reporting", + "name": "Reporting", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } } ] } diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CheckNameAvailability.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_CheckNameAvailability.json similarity index 91% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CheckNameAvailability.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_CheckNameAvailability.json index 6df5c0d04a90..5a6974b9b9d1 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CheckNameAvailability.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_CheckNameAvailability.json @@ -2,7 +2,7 @@ "title": "Accounts_CheckNameAvailability", "operationId": "Accounts_CheckNameAvailability", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "body": { "name": "dummyName", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CreateOrUpdate.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_CreateOrUpdate.json similarity index 93% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CreateOrUpdate.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_CreateOrUpdate.json index 8cf5222500f7..a234a1b01873 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CreateOrUpdate.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_CreateOrUpdate.json @@ -2,7 +2,7 @@ "title": "Accounts_CreateOrUpdate", "operationId": "Accounts_CreateOrUpdate", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", "accountName": "myPlaywrightAccount", @@ -25,7 +25,8 @@ "provisioningState": "Succeeded", "regionalAffinity": "Enabled", "scalableExecution": "Enabled", - "reporting": "Enabled" + "reporting": "Enabled", + "localAuth": "Enabled" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", "name": "myPlaywrightAccount", @@ -54,7 +55,8 @@ "provisioningState": "Succeeded", "regionalAffinity": "Enabled", "scalableExecution": "Enabled", - "reporting": "Enabled" + "reporting": "Enabled", + "localAuth": "Enabled" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", "name": "myPlaywrightAccount", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Delete.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Delete.json similarity index 89% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Delete.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Delete.json index 3696889a7113..7cae943bfa5b 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Delete.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Delete.json @@ -2,7 +2,7 @@ "title": "Accounts_Delete", "operationId": "Accounts_Delete", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", "accountName": "myPlaywrightAccount" @@ -13,7 +13,6 @@ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.PlaywrightTesting/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" } }, - "204": {}, - "200": {} + "204": {} } } diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Get.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Get.json similarity index 91% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Get.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Get.json index 9d4da3abb841..80589b3a0d43 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Get.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Get.json @@ -2,7 +2,7 @@ "title": "Accounts_Get", "operationId": "Accounts_Get", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", "accountName": "myPlaywrightAccount" @@ -16,7 +16,8 @@ "provisioningState": "Succeeded", "regionalAffinity": "Enabled", "scalableExecution": "Enabled", - "reporting": "Enabled" + "reporting": "Enabled", + "localAuth": "Enabled" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", "name": "myPlaywrightAccount", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListByResourceGroup.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_ListByResourceGroup.json similarity index 91% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListByResourceGroup.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_ListByResourceGroup.json index 68e31fede344..ac9b19b89bd9 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListByResourceGroup.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_ListByResourceGroup.json @@ -2,7 +2,7 @@ "title": "Accounts_ListByResourceGroup", "operationId": "Accounts_ListByResourceGroup", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg" }, @@ -17,7 +17,8 @@ "provisioningState": "Succeeded", "regionalAffinity": "Enabled", "scalableExecution": "Enabled", - "reporting": "Enabled" + "reporting": "Enabled", + "localAuth": "Enabled" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", "name": "myPlaywrightAccount", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListBySubscription.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_ListBySubscription.json similarity index 91% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListBySubscription.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_ListBySubscription.json index 93f998037f7c..9f69e6613af9 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListBySubscription.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_ListBySubscription.json @@ -2,7 +2,7 @@ "title": "Accounts_ListBySubscription", "operationId": "Accounts_ListBySubscription", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -16,7 +16,8 @@ "provisioningState": "Succeeded", "regionalAffinity": "Enabled", "scalableExecution": "Enabled", - "reporting": "Enabled" + "reporting": "Enabled", + "localAuth": "Enabled" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", "name": "myPlaywrightAccount", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Update.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Update.json similarity index 92% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Update.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Update.json index ba297638039d..fcf41d1790c8 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Update.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Accounts_Update.json @@ -2,7 +2,7 @@ "title": "Accounts_Update", "operationId": "Accounts_Update", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", "accountName": "myPlaywrightAccount", @@ -25,7 +25,8 @@ "provisioningState": "Succeeded", "regionalAffinity": "Enabled", "scalableExecution": "Enabled", - "reporting": "Enabled" + "reporting": "Enabled", + "localAuth": "Enabled" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", "name": "myPlaywrightAccount", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Operations_List.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Operations_List.json similarity index 97% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Operations_List.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Operations_List.json index e668f47e311f..ac7921c7fac5 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Operations_List.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Operations_List.json @@ -2,7 +2,7 @@ "title": "Operations_List", "operationId": "Operations_List", "parameters": { - "api-version": "2024-02-01-preview" + "api-version": "2024-08-01-preview" }, "responses": { "200": { diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_Get.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Quotas_Get.json similarity index 89% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_Get.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Quotas_Get.json index 17492117a25b..c36333e1fe8b 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_Get.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Quotas_Get.json @@ -2,7 +2,7 @@ "title": "Quotas_Get", "operationId": "Quotas_Get", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "location": "eastus", "quotaName": "ScalableExecution" @@ -18,6 +18,7 @@ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "state": "Active" }, + "offeringType": "NotApplicable", "provisioningState": "Succeeded" } } diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_ListBySubscription.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Quotas_ListBySubscription.json similarity index 55% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_ListBySubscription.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Quotas_ListBySubscription.json index 2e002359dd73..57f16834b778 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_ListBySubscription.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-08-01-preview/Quotas_ListBySubscription.json @@ -2,7 +2,7 @@ "title": "Quotas_ListBySubscription", "operationId": "Quotas_ListBySubscription", "parameters": { - "api-version": "2024-02-01-preview", + "api-version": "2024-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "location": "eastus" }, @@ -16,11 +16,25 @@ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "state": "Active" }, + "offeringType": "NotApplicable", "provisioningState": "Succeeded" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzurePlaywrightService/locations/eastus/quotas/ScalableExecution", "name": "ScalableExecution", "type": "Microsoft.AzurePlaywrightService/Locations/Quotas" + }, + { + "properties": { + "freeTrial": { + "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "state": "Active" + }, + "offeringType": "PrivatePreview", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzurePlaywrightService/locations/eastus/quotas/Reporting", + "name": "Reporting", + "type": "Microsoft.AzurePlaywrightService/Locations/Quotas" } ] } diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp index f90575183eac..58b920334975 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp +++ b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp @@ -20,10 +20,10 @@ namespace Microsoft.AzurePlaywrightService; @doc("Microsoft.AzurePlaywrightService Management API Versions.") enum Versions { - /** 2024-02-01-preview version */ + /** 2024-08-01-preview version */ @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) - `2024-02-01-preview`, + `2024-08-01-preview`, } interface Operations extends Azure.ResourceManager.Operations {} @@ -53,7 +53,10 @@ model AccountProperties { scalableExecution?: EnablementStatus = EnablementStatus.Enabled; @doc("When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.") - reporting?: EnablementStatus = EnablementStatus.Disabled; + reporting?: EnablementStatus = EnablementStatus.Enabled; + + @doc("When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs.") + localAuth?: EnablementStatus = EnablementStatus.Disabled; @visibility("read") @doc("The status of the last operation.") @@ -98,6 +101,16 @@ interface Accounts Account, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; + + delete is ArmResourceDeleteWithoutOkAsync; + + update is ArmCustomPatchSync< + Account, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Account, + OmitDefaults + > + >; } @doc("The location of subscription quota resource.") @@ -128,6 +141,9 @@ union QuotaNames { @doc("The quota details for scalable execution feature. When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.") "ScalableExecution", + + @doc("The quota details for reporting feature. When enabled, Playwright client will be able to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.") + Reporting: "Reporting", } @doc("The subscription quota resource properties.") @@ -135,6 +151,10 @@ model QuotaProperties { @doc("The subscription quota resource free-trial properties.") freeTrial?: FreeTrialProperties; + @doc("Indicates the offering type for the subscription.") + @visibility("read") + offeringType?: OfferingType; + @visibility("read") @doc("The status of the last operation.") provisioningState?: ProvisioningState; @@ -214,6 +234,23 @@ union FreeTrialState { "NotRegistered", } +@doc("Offering type state.") +union OfferingType { + string, + + @doc("The offeringType is NotApplicable.") + "NotApplicable", + + @doc("The offeringType is PrivatePreview.") + "PrivatePreview", + + @doc("The offeringType is PublicPreview.") + "PublicPreview", + + @doc("The offeringType is GeneralAvailability.") + "GeneralAvailability", +} + @armResourceOperations interface Quotas { @doc("Get subscription quota by name.") diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml b/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml index dc3d55e97378..425c79f8ec1a 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml +++ b/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml @@ -19,6 +19,7 @@ options: examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/playwrighttesting.json" omit-unreachable-types: true + use-read-only-status-schema: true # "@azure-tools/typespec-providerhub-controller": # azure-resource-provider-folder: "resource-manager" # emitter-output-dir: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/generated" diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_Get.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_Get.json new file mode 100644 index 000000000000..96a9c6e6d1f0 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_Get.json @@ -0,0 +1,30 @@ +{ + "title": "AccountQuotas_Get", + "operationId": "AccountQuotas_Get", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount", + "quotaName": "ScalableExecution" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_ListByAccount.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_ListByAccount.json new file mode 100644 index 000000000000..4a10a56c6c8b --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/AccountQuotas_ListByAccount.json @@ -0,0 +1,48 @@ +{ + "title": "AccountQuotas_ListByAccount", + "operationId": "AccountQuotas_ListByAccount", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/Reporting", + "name": "Reporting", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CheckNameAvailability.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CheckNameAvailability.json new file mode 100644 index 000000000000..5a6974b9b9d1 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "title": "Accounts_CheckNameAvailability", + "operationId": "Accounts_CheckNameAvailability", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "name": "dummyName", + "type": "Microsoft.AzurePlaywrightService/Accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "Test message." + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..a234a1b01873 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,78 @@ +{ + "title": "Accounts_CreateOrUpdate", + "operationId": "Accounts_CreateOrUpdate", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount", + "resource": { + "location": "westus", + "tags": { + "Team": "Dev Exp" + }, + "properties": { + "regionalAffinity": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled", + "localAuth": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.PlaywrightTesting/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2023-06-01-preview" + }, + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled", + "localAuth": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Delete.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..7cae943bfa5b --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Accounts_Delete", + "operationId": "Accounts_Delete", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.PlaywrightTesting/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Get.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..80589b3a0d43 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Get.json @@ -0,0 +1,39 @@ +{ + "title": "Accounts_Get", + "operationId": "Accounts_Get", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled", + "localAuth": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListByResourceGroup.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListByResourceGroup.json new file mode 100644 index 000000000000..ac9b19b89bd9 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "title": "Accounts_ListByResourceGroup", + "operationId": "Accounts_ListByResourceGroup", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled", + "localAuth": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListBySubscription.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListBySubscription.json new file mode 100644 index 000000000000..9f69e6613af9 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "title": "Accounts_ListBySubscription", + "operationId": "Accounts_ListBySubscription", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled", + "localAuth": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Update.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..fcf41d1790c8 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Accounts_Update.json @@ -0,0 +1,48 @@ +{ + "title": "Accounts_Update", + "operationId": "Accounts_Update", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount", + "properties": { + "tags": { + "Team": "Dev Exp", + "Division": "LT" + }, + "properties": { + "regionalAffinity": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled", + "localAuth": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Operations_List.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..ac7921c7fac5 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Operations_List.json @@ -0,0 +1,46 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzurePlaywrightService/accounts/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzurePlaywrightService", + "resource": "accounts", + "operation": "Creates or updates the PlaywrightAccounts", + "description": "Set PlaywrightAccounts" + } + }, + { + "name": "Microsoft.AzurePlaywrightService/accounts/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzurePlaywrightService", + "resource": "accounts", + "operation": "Deletes the PlaywrightAccounts", + "description": "Delete PlaywrightAccounts" + } + }, + { + "name": "Microsoft.AzurePlaywrightService/accounts/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzurePlaywrightService", + "resource": "accounts", + "operation": "Reads the PlaywrightAccounts", + "description": "Read PlaywrightAccounts" + } + } + ], + "nextLink": "http://nextlink.contoso.com" + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_Get.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_Get.json new file mode 100644 index 000000000000..c36333e1fe8b --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_Get.json @@ -0,0 +1,27 @@ +{ + "title": "Quotas_Get", + "operationId": "Quotas_Get", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "quotaName": "ScalableExecution" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzurePlaywrightService/locations/eastus/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Locations/Quotas", + "properties": { + "freeTrial": { + "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "state": "Active" + }, + "offeringType": "NotApplicable", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_ListBySubscription.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_ListBySubscription.json new file mode 100644 index 000000000000..57f16834b778 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/examples/Quotas_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "Quotas_ListBySubscription", + "operationId": "Quotas_ListBySubscription", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "freeTrial": { + "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "state": "Active" + }, + "offeringType": "NotApplicable", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzurePlaywrightService/locations/eastus/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Locations/Quotas" + }, + { + "properties": { + "freeTrial": { + "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "state": "Active" + }, + "offeringType": "PrivatePreview", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzurePlaywrightService/locations/eastus/quotas/Reporting", + "name": "Reporting", + "type": "Microsoft.AzurePlaywrightService/Locations/Quotas" + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/playwrighttesting.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/playwrighttesting.json new file mode 100644 index 000000000000..ba855c509b14 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/playwrighttesting.json @@ -0,0 +1,1219 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft AzurePlaywrightService Management API", + "version": "2024-08-01-preview", + "description": "Microsoft.AzurePlaywrightService Resource Provider Management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Accounts" + }, + { + "name": "Quotas" + }, + { + "name": "AccountQuotas" + } + ], + "paths": { + "/providers/Microsoft.AzurePlaywrightService/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/accounts": { + "get": { + "operationId": "Accounts_ListBySubscription", + "tags": [ + "Accounts" + ], + "description": "List Account resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_ListBySubscription": { + "$ref": "./examples/Accounts_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/checkNameAvailability": { + "post": { + "operationId": "Accounts_CheckNameAvailability", + "tags": [ + "Accounts" + ], + "description": "Adds check global name availability operation, normally used if a resource name must be globally unique.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_CheckNameAvailability": { + "$ref": "./examples/Accounts_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/locations/{location}/quotas": { + "get": { + "operationId": "Quotas_ListBySubscription", + "tags": [ + "Quotas" + ], + "description": "List quotas for a given subscription Id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "The location of quota in ARM Normalized format like eastus, southeastasia etc.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Quotas_ListBySubscription": { + "$ref": "./examples/Quotas_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/locations/{location}/quotas/{quotaName}": { + "get": { + "operationId": "Quotas_Get", + "tags": [ + "Quotas" + ], + "description": "Get subscription quota by name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "The location of quota in ARM Normalized format like eastus, southeastasia etc.", + "required": true, + "type": "string" + }, + { + "name": "quotaName", + "in": "path", + "description": "The quota name.", + "required": true, + "type": "string", + "enum": [ + "ScalableExecution", + "Reporting" + ], + "x-ms-enum": { + "name": "QuotaNames", + "modelAsString": true, + "values": [ + { + "name": "ScalableExecution", + "value": "ScalableExecution", + "description": "The quota details for scalable execution feature. When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations." + }, + { + "name": "Reporting", + "value": "Reporting", + "description": "The quota details for reporting feature. When enabled, Playwright client will be able to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Quota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Quotas_Get": { + "$ref": "./examples/Quotas_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts": { + "get": { + "operationId": "Accounts_ListByResourceGroup", + "tags": [ + "Accounts" + ], + "description": "List Account resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_ListByResourceGroup": { + "$ref": "./examples/Accounts_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}": { + "get": { + "operationId": "Accounts_Get", + "tags": [ + "Accounts" + ], + "description": "Get a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "./examples/Accounts_Get.json" + } + } + }, + "put": { + "operationId": "Accounts_CreateOrUpdate", + "tags": [ + "Accounts" + ], + "description": "Create a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Account' update operation succeeded", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "Resource 'Account' create operation succeeded", + "schema": { + "$ref": "#/definitions/Account" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "./examples/Accounts_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Accounts_Update", + "tags": [ + "Accounts" + ], + "description": "Update a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AccountUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "./examples/Accounts_Update.json" + } + } + }, + "delete": { + "operationId": "Accounts_Delete", + "tags": [ + "Accounts" + ], + "description": "Delete a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "./examples/Accounts_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas": { + "get": { + "operationId": "AccountQuotas_ListByAccount", + "tags": [ + "AccountQuotas" + ], + "description": "List quotas for a given account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountQuotaListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccountQuotas_ListByAccount": { + "$ref": "./examples/AccountQuotas_ListByAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas/{quotaName}": { + "get": { + "operationId": "AccountQuotas_Get", + "tags": [ + "AccountQuotas" + ], + "description": "Get quota by name for an account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + }, + { + "name": "quotaName", + "in": "path", + "description": "The Playwright service account quota name.", + "required": true, + "type": "string", + "enum": [ + "ScalableExecution", + "Reporting" + ], + "x-ms-enum": { + "name": "QuotaNames", + "modelAsString": true, + "values": [ + { + "name": "ScalableExecution", + "value": "ScalableExecution", + "description": "The quota details for scalable execution feature. When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations." + }, + { + "name": "Reporting", + "value": "Reporting", + "description": "The quota details for reporting feature. When enabled, Playwright client will be able to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountQuota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccountQuotas_Get": { + "$ref": "./examples/AccountQuotas_Get.json" + } + } + } + } + }, + "definitions": { + "Account": { + "type": "object", + "description": "A Playwright service account resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AccountFreeTrialProperties": { + "type": "object", + "description": "The Playwright service account quota resource free-trial properties.", + "properties": { + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The free-trial createdAt utcDateTime.", + "readOnly": true + }, + "expiryAt": { + "type": "string", + "format": "date-time", + "description": "The free-trial expiryAt utcDateTime.", + "readOnly": true + }, + "allocatedValue": { + "type": "integer", + "format": "int32", + "description": "The free-trial allocated limit value eg. allocated free minutes.", + "readOnly": true + }, + "usedValue": { + "type": "integer", + "format": "int32", + "description": "The free-trial used value eg. used free minutes.", + "readOnly": true + }, + "percentageUsed": { + "type": "number", + "format": "float", + "description": "The free-trial percentage used.", + "minimum": 0, + "maximum": 100, + "readOnly": true + } + }, + "required": [ + "createdAt", + "expiryAt", + "allocatedValue", + "usedValue", + "percentageUsed" + ] + }, + "AccountListResult": { + "type": "object", + "description": "The response of a Account list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Account items on this page", + "items": { + "$ref": "#/definitions/Account" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AccountProperties": { + "type": "object", + "description": "Account resource properties.", + "properties": { + "dashboardUri": { + "type": "string", + "format": "uri", + "description": "The Playwright testing dashboard URI for the account resource.", + "readOnly": true + }, + "regionalAffinity": { + "type": "string", + "description": "This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "scalableExecution": { + "type": "string", + "description": "When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "reporting": { + "type": "string", + "description": "When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "localAuth": { + "type": "string", + "description": "When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AccountQuota": { + "type": "object", + "description": "A quota resource for a Playwright service account.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountQuotaProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AccountQuotaListResult": { + "type": "object", + "description": "The response of a AccountQuota list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AccountQuota items on this page", + "items": { + "$ref": "#/definitions/AccountQuota" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AccountQuotaProperties": { + "type": "object", + "description": "The Playwright service account quota resource properties.", + "properties": { + "freeTrial": { + "$ref": "#/definitions/AccountFreeTrialProperties", + "description": "The Playwright service account quota resource free-trial properties." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AccountUpdate": { + "type": "object", + "description": "The type used for update operations of the Account.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AccountUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "AccountUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Account.", + "properties": { + "regionalAffinity": { + "$ref": "#/definitions/EnablementStatus", + "description": "This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created." + }, + "scalableExecution": { + "$ref": "#/definitions/EnablementStatus", + "description": "When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations." + }, + "reporting": { + "$ref": "#/definitions/EnablementStatus", + "description": "When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting." + }, + "localAuth": { + "$ref": "#/definitions/EnablementStatus", + "description": "When enabled, this feature allows the workspace to use local auth(through access key) for authentication of test runs." + } + } + }, + "EnablementStatus": { + "type": "string", + "description": "The enablement status of a feature.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "FreeTrialProperties": { + "type": "object", + "description": "The subscription quota resource free-trial properties.", + "properties": { + "accountId": { + "type": "string", + "description": "The Playwright service account id.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/FreeTrialState", + "description": "The free-trial state.", + "readOnly": true + } + }, + "required": [ + "accountId", + "state" + ] + }, + "FreeTrialState": { + "type": "string", + "description": "The free-trial state.", + "enum": [ + "Active", + "Expired", + "NotEligible", + "NotRegistered" + ], + "x-ms-enum": { + "name": "FreeTrialState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The free-trial is Active." + }, + { + "name": "Expired", + "value": "Expired", + "description": "The free-trial is Expired." + }, + { + "name": "NotEligible", + "value": "NotEligible", + "description": "The free-trial is Not Eligible." + }, + { + "name": "NotRegistered", + "value": "NotRegistered", + "description": "The free-trial is Not Registered." + } + ] + } + }, + "OfferingType": { + "type": "string", + "description": "Offering type state.", + "enum": [ + "NotApplicable", + "PrivatePreview", + "PublicPreview", + "GeneralAvailability" + ], + "x-ms-enum": { + "name": "OfferingType", + "modelAsString": true, + "values": [ + { + "name": "NotApplicable", + "value": "NotApplicable", + "description": "The offeringType is NotApplicable." + }, + { + "name": "PrivatePreview", + "value": "PrivatePreview", + "description": "The offeringType is PrivatePreview." + }, + { + "name": "PublicPreview", + "value": "PublicPreview", + "description": "The offeringType is PublicPreview." + }, + { + "name": "GeneralAvailability", + "value": "GeneralAvailability", + "description": "The offeringType is GeneralAvailability." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Creation in progress.." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress.." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Change accepted for processing.." + } + ] + }, + "readOnly": true + }, + "Quota": { + "type": "object", + "description": "A subscription quota resource.", + "properties": { + "properties": { + "$ref": "#/definitions/QuotaProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "QuotaListResult": { + "type": "object", + "description": "The response of a Quota list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Quota items on this page", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "QuotaProperties": { + "type": "object", + "description": "The subscription quota resource properties.", + "properties": { + "freeTrial": { + "$ref": "#/definitions/FreeTrialProperties", + "description": "The subscription quota resource free-trial properties." + }, + "offeringType": { + "$ref": "#/definitions/OfferingType", + "description": "Indicates the offering type for the subscription.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/playwrighttesting/resource-manager/readme.md b/specification/playwrighttesting/resource-manager/readme.md index 5ad5e43c95bb..2b2875230078 100644 --- a/specification/playwrighttesting/resource-manager/readme.md +++ b/specification/playwrighttesting/resource-manager/readme.md @@ -29,7 +29,33 @@ title: PlaywrightTestingClient description: Azure Playwright testing management service openapi-type: arm openapi-subtype: rpaas -tag: package-2024-02-01-preview +tag: package-2024-08-01-preview +``` + +### Tag: package-2024-08-01-preview + +These settings apply only when `--tag=package-2024-08-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-01-preview' +input-file: + - Microsoft.AzurePlaywrightService/preview/2024-08-01-preview/playwrighttesting.json +suppressions: + - code: ResourceNameRestriction + from: playwrighttesting.json + reason: We have enums defined for quota resource names which doesn't support string pattern validation. + - code: ProvisioningStateMustBeReadOnly + from: playwrighttesting.json + reason: Seems like a tool bug, as the visibility is set to read only in the TypeSpec already. + - code: DeleteResponseCodes + from: playwrighttesting.json + reason: Seems like a tool bug, as default operations with codes are generated from the TrackedResourceOperations in the TypeSpec. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}"].delete +``` + +``` yaml +modelerfour: + flatten-models: false ``` ### Tag: package-2024-02-01-preview From f1e65f90e77a72258801439e757fc76ecb13a7fc Mon Sep 17 00:00:00 2001 From: Aurgho Bhattacharjee Date: Thu, 29 Aug 2024 13:50:31 -0700 Subject: [PATCH 25/30] Add missing client config renames for analyze documents (#30368) * Add missing client config renames for analyze documents * minor change * Remove confidence score rename --------- Co-authored-by: Aurgho Bhattacharjee --- .../Language.AnalyzeDocuments/client.tsp | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp b/specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp index e66bbddbca35..59837065b498 100644 --- a/specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp +++ b/specification/cognitiveservices/Language.AnalyzeDocuments/client.tsp @@ -22,6 +22,8 @@ namespace Language.AnalyzeTextClientCustomizations; @@clientName(WarningCodeValue, "WarningCode", "csharp"); +@@clientName(AnalyzeDocumentsLROTask.taskName, "Name", "csharp"); + @@clientName(PiiCategoriesExclude.ABARoutingNumber, "AbaRoutingNumber", "csharp" @@ -600,3 +602,57 @@ namespace Language.AnalyzeTextClientCustomizations; "ExtractiveSummarizationActionContent", "csharp" ); + +@@clientName(AnalyzeDocumentJobsInput, + "AnalyzeDocumentsOperationInput", + "csharp" +); +@@clientName(AnalyzeDocumentJobsInput.analysisInput, + "DocumentsInput", + "csharp" +); +@@clientName(AnalyzeDocumentJobsInput.tasks, "Actions", "csharp"); + +@@clientName(AnalyzeDocumentsLROResultsKind, + "AnalyzeDocumentsOperationResultsKind", + "csharp" +); +@@clientName(AnalyzeDocumentsLROResultsKind.AbstractiveSummarizationLROResults, + "AbstractiveSummarizationOperationResults", + "csharp" +); +@@clientName(AnalyzeDocumentsLROResultsKind.ExtractiveSummarizationLROResults, + "ExtractiveSummarizationOperationResults", + "csharp" +); +@@clientName(AnalyzeDocumentsLROResultsKind.PiiEntityRecognitionLROResults, + "PiiEntityRecognitionOperationResults", + "csharp" +); + +@@clientName(PiiEntityRecognitionLROResult, + "PiiEntityRecognitionOperationResult", + "csharp" +); +@@clientName(AbstractiveSummarizationLROResult, + "AbstractiveSummarizationOperationResult", + "csharp" +); +@@clientName(ExtractiveSummarizationLROResult, + "ExtractiveSummarizationOperationResult", + "csharp" +); + +@@clientName(analyzeDocumentsSubmitJob, + "AnalyzeDocumentsSubmitOperation", + "csharp" +); + +@@clientName(analyzeDocumentsJobStatus, + "GetAnalyzeDocumentsJobStatus", + "csharp" +); +@@clientName(analyzeDocumentsCancelJob, + "AnalyzeDocumentsCancelOperation", + "csharp" +); From d6be8f199982997f0a94e3e9bbbe8b2f7e304f7d Mon Sep 17 00:00:00 2001 From: FumingZhang <81607949+FumingZhang@users.noreply.github.com> Date: Sat, 31 Aug 2024 00:06:43 +0800 Subject: [PATCH 26/30] Review request for Microsoft.ContainerService/aks to add version stable/2024-07-01 (#30291) * Adds base for updating Microsoft.ContainerService/aks from version stable/2024-05-01 to version 2024-07-01 * Updates API version in new specs and examples * Add TL fields to July 2024-07-01 stable api (#30084) Co-authored-by: Lily Pan * added list mahcines and get machine to swagger (#30137) * added list mahcines and get machine to swagger * added definitions * adding example files * manchine name param * changing api version * modified example jsons * addressing comments * changed example params to match regex pattern * moving summary & tags to top * Updates readme * GA Delete Machines API (#30318) * impl * fix * addressing comments (#30366) * addressing comments * run prettier check * Update sdk-suppressions.yaml --------- Co-authored-by: lilypan26 Co-authored-by: Lily Pan Co-authored-by: skuchipudi295 <128435195+skuchipudi295@users.noreply.github.com> Co-authored-by: Xu Xue <55420084+xuexu6666@users.noreply.github.com> Co-authored-by: Yuchao Yan --- .../aks/readme.java.md | 14 + .../Microsoft.ContainerService/aks/readme.md | 11 +- .../aks/readme.python.md | 13 +- .../aks/sdk-suppressions.yaml | 1 + .../examples/AgentPoolsAbortOperation.json | 18 + .../examples/AgentPoolsCreate_CRG.json | 54 + .../AgentPoolsCreate_CustomNodeConfig.json | 124 + .../AgentPoolsCreate_DedicatedHostGroup.json | 52 + ...entPoolsCreate_EnableEncryptionAtHost.json | 54 + .../examples/AgentPoolsCreate_EnableFIPS.json | 54 + .../AgentPoolsCreate_EnableUltraSSD.json | 54 + .../examples/AgentPoolsCreate_Ephemeral.json | 58 + .../examples/AgentPoolsCreate_GPUMIG.json | 127 + .../examples/AgentPoolsCreate_OSSKU.json | 127 + .../examples/AgentPoolsCreate_PPG.json | 54 + .../examples/AgentPoolsCreate_Snapshot.json | 63 + .../examples/AgentPoolsCreate_Spot.json | 86 + .../examples/AgentPoolsCreate_Update.json | 88 + .../examples/AgentPoolsCreate_WasmWasi.json | 60 + ...PoolsCreate_WindowsDisableOutboundNAT.json | 63 + .../AgentPoolsCreate_WindowsOSSKU.json | 54 + .../2024-07-01/examples/AgentPoolsDelete.json | 17 + .../examples/AgentPoolsDeleteMachines.json | 22 + .../2024-07-01/examples/AgentPoolsGet.json | 30 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../2024-07-01/examples/AgentPoolsList.json | 30 + .../AgentPoolsUpgradeNodeImageVersion.json | 34 + .../2024-07-01/examples/AgentPools_Start.json | 52 + .../2024-07-01/examples/AgentPools_Stop.json | 52 + .../examples/AgentPools_Update.json | 75 + .../examples/KubernetesVersions_List.json | 97 + .../2024-07-01/examples/MachineGet.json | 34 + .../2024-07-01/examples/MachineList.json | 38 + ...aintenanceConfigurationsCreate_Update.json | 94 + ...ationsCreate_Update_MaintenanceWindow.json | 98 + .../MaintenanceConfigurationsDelete.json | 13 + ...onfigurationsDelete_MaintenanceWindow.json | 13 + .../MaintenanceConfigurationsGet.json | 42 + ...ceConfigurationsGet_MaintenanceWindow.json | 40 + .../MaintenanceConfigurationsList.json | 37 + ...eConfigurationsList_MaintenanceWindow.json | 61 + .../ManagedClustersAbortOperation.json | 17 + ...rsCreate_AzureKeyvaultSecretsProvider.json | 259 + ...anagedClustersCreate_AzureServiceMesh.json | 346 + .../examples/ManagedClustersCreate_CRG.json | 254 + ...agedClustersCreate_DedicatedHostGroup.json | 249 + ...nagedClustersCreate_DisableRunCommand.json | 267 + ...gedClustersCreate_DualStackNetworking.json | 323 + ...ClustersCreate_EnableEncryptionAtHost.json | 256 + .../ManagedClustersCreate_EnableUltraSSD.json | 256 + .../ManagedClustersCreate_EnabledFIPS.json | 256 + .../ManagedClustersCreate_GPUMIG.json | 283 + .../ManagedClustersCreate_HTTPProxy.json | 280 + ...rsCreate_IngressProfile_WebAppRouting.json | 249 + ...nagedClustersCreate_ManagedNATGateway.json | 233 + ...agedClustersCreate_NodePublicIPPrefix.json | 256 + .../examples/ManagedClustersCreate_OSSKU.json | 283 + .../examples/ManagedClustersCreate_PPG.json | 256 + .../ManagedClustersCreate_PodIdentity.json | 265 + .../ManagedClustersCreate_Premium.json | 274 + ...ersCreate_PrivateClusterFQDNSubdomain.json | 266 + ...ustersCreate_PrivateClusterPublicFQDN.json | 270 + ...ManagedClustersCreate_SecurityProfile.json | 262 + .../ManagedClustersCreate_Snapshot.json | 265 + .../ManagedClustersCreate_Update.json | 317 + ...nagedClustersCreate_UpdateWindowsGmsa.json | 301 + .../ManagedClustersCreate_UpdateWithAHUB.json | 295 + ...stersCreate_UpdateWithEnableAzureRBAC.json | 284 + ...ClustersCreate_UserAssignedNATGateway.json | 200 + .../examples/ManagedClustersDelete.json | 16 + .../examples/ManagedClustersGet.json | 113 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + ...anagedClustersGet_MeshRevisionProfile.json | 53 + ...ManagedClustersGet_MeshUpgradeProfile.json | 35 + .../examples/ManagedClustersList.json | 66 + .../ManagedClustersListByResourceGroup.json | 67 + ...edClustersListClusterAdminCredentials.json | 20 + ...sListClusterMonitoringUserCredentials.json | 20 + ...gedClustersListClusterUserCredentials.json | 20 + ...agedClustersList_MeshRevisionProfiles.json | 56 + ...nagedClustersList_MeshUpgradeProfiles.json | 38 + .../ManagedClustersResetAADProfile.json | 22 + ...dClustersResetServicePrincipalProfile.json | 20 + ...agedClustersRotateClusterCertificates.json | 16 + ...ustersRotateServiceAccountSigningKeys.json | 16 + .../examples/ManagedClustersStart.json | 16 + .../examples/ManagedClustersStop.json | 16 + .../examples/ManagedClustersUpdateTags.json | 68 + .../2024-07-01/examples/Operation_List.json | 3573 ++++++++ ...boundNetworkDependenciesEndpointsList.json | 242 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 27 + .../PrivateEndpointConnectionsList.json | 30 + .../PrivateEndpointConnectionsUpdate.json | 50 + .../examples/PrivateLinkResourcesList.json | 25 + .../examples/ResolvePrivateLinkServiceId.json | 18 + .../examples/RunCommandRequest.json | 33 + .../examples/RunCommandResultFailed.json | 25 + .../examples/RunCommandResultSucceed.json | 28 + .../2024-07-01/examples/SnapshotsCreate.json | 80 + .../2024-07-01/examples/SnapshotsDelete.json | 12 + .../2024-07-01/examples/SnapshotsGet.json | 39 + .../2024-07-01/examples/SnapshotsList.json | 41 + .../SnapshotsListByResourceGroup.json | 42 + .../examples/SnapshotsUpdateTags.json | 45 + ...stedAccessRoleBindings_CreateOrUpdate.json | 48 + .../TrustedAccessRoleBindings_Delete.json | 17 + .../TrustedAccessRoleBindings_Get.json | 25 + .../TrustedAccessRoleBindings_List.json | 28 + .../examples/TrustedAccessRoles_List.json | 34 + .../stable/2024-07-01/managedClusters.json | 7847 +++++++++++++++++ 113 files changed, 22559 insertions(+), 2 deletions(-) create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Ephemeral.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WasmWasi.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsOSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDeleteMachines.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Start.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Stop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/KubernetesVersions_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureServiceMesh.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DisableRunCommand.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DualStackNetworking.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnabledFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_HTTPProxy.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PodIdentity.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Premium.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_SecurityProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshRevisionProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterAdminCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterUserCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshRevisionProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshUpgradeProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStart.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/Operation_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateLinkResourcesList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ResolvePrivateLinkServiceId.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandRequest.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultFailed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultSucceed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsCreate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Delete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Get.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoles_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/managedClusters.json diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md index 5894164eb3d8..5b096efafa10 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md @@ -102,6 +102,20 @@ batch: - tag: package-preview-2024-05 - tag: package-2024-05 - tag: package-preview-2024-06 + - tag: package-2024-07 +``` + +### Tag: package-2024-07 and java + +These settings apply only when `--tag=package-2024-07` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2024_07_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2024_07_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-preview-2024-06 and java diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 857c5d3cf87a..89e234bff85a 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -34,7 +34,16 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-preview-2024-06 +tag: package-2024-07 +``` + +### Tag: package-2024-07 + +These settings apply only when `--tag=package-2024-07` is specified on the command line. + +``` yaml $(tag) == 'package-2024-07' +input-file: + - stable/2024-07-01/managedClusters.json ``` ### Tag: package-preview-2024-06 diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md index d01485b89f38..dd08beb040f3 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md @@ -16,9 +16,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2024-06-02-preview" +default-api-version: "2024-07-01" multiapi: true batch: + - tag: package-2024-07 - tag: package-preview-2024-06 - tag: package-2024-05 - tag: package-preview-2024-05 @@ -109,6 +110,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2024-07 and python + +These settings apply only when `--tag=package-2024-07 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-07' && $(python) +namespace: azure.mgmt.containerservice.v2024_07_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2024_07_01 +``` + ### Tag: package-preview-2024-06 and python These settings apply only when `--tag=package-preview-2024-06 --python` is specified on the command line. diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml index cd6278a277a2..085499db45e0 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml @@ -12,6 +12,7 @@ suppressions: - Removed operation ManagedClustersOperations.get_os_options - Model ManagedClusterAzureMonitorProfileAppMonitoring no longer has parameter enabled - Model ManagedClusterAzureMonitorProfileContainerInsights no longer has parameter windows_host_logs + - Model AgentPoolSecurityProfile no longer has parameter ssh_access azure-sdk-for-js: - package: '@azure/arm-containerservice' breaking-changes: diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..7299ba938d24 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-07-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CRG.json new file mode 100644 index 000000000000..a80721c74a76 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..6902b146ac8f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..7f2f264ce422 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..081fe4ed1da1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..dd92beed0abc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..cec2d84b601d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..da88ea92fa29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..8feb6bde71ef --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..591e20a261af --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..06c0e0615332 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..6cb532a676f7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..ba6f72076bf2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..827c9bb52f23 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..1cdff9018c03 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..04784d21f8c1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..0793c869d641 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..feb21138f792 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDeleteMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDeleteMachines.json new file mode 100644 index 000000000000..7fd16e7ad402 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsDeleteMachines.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machines": { + "machineNames": [ + "aks-nodepool1-42263519-vmss00000a", + "aks-nodepool1-42263519-vmss00000b" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..396188d1f49e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..3264036e9b09 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..009a917eef50 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..a4a4d0269883 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..3f48f4f9d86c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Start.json new file mode 100644 index 000000000000..ece04ffefe54 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..b8293bb36815 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..f64c20426e94 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..9b5c946d919d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/KubernetesVersions_List.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "isDefault": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "isPreview": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineGet.json new file mode 100644 index 000000000000..ee7dfe96448c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "26fe00f8-9173-4872-9134-bb1d2e00343a", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machineName": "aks-nodepool1-42263519-vmss00000t" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineList.json new file mode 100644 index 000000000000..ca4327200b16 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MachineList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "26fe00f8-9173-4872-9134-bb1d2e00343a", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + ], + "nextLink": "http://xxxx.azure.com?encodedToken=c2tpcFRva2VuPTE" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..2fe907d41106 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..0d0ee3e27234 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..865513d12c38 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..4a4c940b1a6b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..57f2169613a6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..287454e4c0a7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..4580fa3a9ef3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..69fa8b781920 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..39a6baaf2c91 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-07-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..bf066a695cb8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..f2371c516e6d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_CRG.json new file mode 100644 index 000000000000..d4e56a33754b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..930557b1a68e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..2cefa1c91ba8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..2cd5e9460e6a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..e634e35f36c2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..00297f3bdcc6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..a2363e163425 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..b2f2d30e2bfa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..9f711d78ee4c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..5a510a246c52 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..280b191b29bb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..b29ce56285ff --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..9270e951c722 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..b8f7464b2198 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..90a134648555 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..9bbfdef3d301 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..4f1cc95c1763 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,266 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..8da8f7f91095 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..7cd6553a4c02 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..605b39abd01f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..45625488ba55 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..562edcad0308 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..b1fe249bed29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..f6bec21327ea --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..d829a1e67e1d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..a01b3644897e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..800eb0eff014 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..a43bdb53d063 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..452c75f19698 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..90d1358fc43d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..f12b116ea12e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..522a9dab76a4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..1c36cdfd390a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterAdminCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterAdminCredentials.json new file mode 100644 index 000000000000..228b9db2f7a2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterAdminCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json new file mode 100644 index 000000000000..228b9db2f7a2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterUserCredentials.json new file mode 100644 index 000000000000..228b9db2f7a2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersListClusterUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..958859557a76 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..fd3324fab075 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..d2006bb923c0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..3e8639883d4b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..a01b3644897e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..a01b3644897e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..a01b3644897e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..a01b3644897e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..a4390d2abb87 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/Operation_List.json new file mode 100644 index 000000000000..3e26be253aed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/Operation_List.json @@ -0,0 +1,3573 @@ +{ + "parameters": { + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..ddc7680d5d7e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..269897b82692 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..682629d9ce8a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..d317bbc562ee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..a3496bc20474 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..c6701e7e756c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..af1352a3aee6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..3be7ee380e64 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-07-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..3da4f2c9eb5b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..f4fd85ef462e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..c169e41d8061 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..187e5560d784 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsGet.json new file mode 100644 index 000000000000..ac412e4f6247 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsList.json new file mode 100644 index 000000000000..123f9baa1209 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..6ff844034cd3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..dda417992e0b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..36eaa56d972c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..a69ae7a6f801 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..a738c147527a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..b87e293650e8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..eda5320b3baa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/managedClusters.json new file mode 100644 index 000000000000..b51e33841dab --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-07-01/managedClusters.json @@ -0,0 +1,7847 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2024-07-01" + }, + "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.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterMonitoringUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure KeyVault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Create Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersCreate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Create Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsCreate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_DeleteMachines", + "summary": "Deletes specific machines in an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "machines", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPoolDeleteMachinesParameter" + }, + "description": "A list of machines from the agent pool to be deleted." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Specific Machines in an Agent Pool": { + "$ref": "./examples/AgentPoolsDeleteMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines": { + "get": { + "operationId": "Machines_List", + "summary": "Gets a list of machines in the specified agent pool.", + "tags": [ + "Machines" + ], + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Machines in an Agentpool by Managed Cluster": { + "$ref": "./examples/MachineList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}": { + "get": { + "operationId": "Machines_Get", + "summary": "Get a specific machine in the specified agent pool.", + "tags": [ + "Machines" + ], + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Machine in an Agent Pools by Managed Cluster": { + "$ref": "./examples/MachineGet.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Agent Pool is running.", + "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + }, + "securityProfile": { + "$ref": "#/definitions/AgentPoolSecurityProfile", + "description": "The security settings of an agent pool." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length:** 1 character

**Max-length:** 20 characters" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable Windows gMSA.", + "description": "Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + }, + "rootDomainName": { + "type": "string", + "description": "Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "description": "The IP version to use for cluster networking and IP assignment.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true + } + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "x-ms-identifiers": [], + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First week of the month." + }, + { + "value": "Second", + "description": "Second week of the month." + }, + { + "value": "Third", + "description": "Third week of the month." + }, + { + "value": "Fourth", + "description": "Fourth week of the month." + }, + { + "value": "Last", + "description": "Last week of the month." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which week of the month the dayOfWeek applies." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from empty nodes", + "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from non-empty nodes", + "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "title": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down", + "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "NodeImage", + "SecurityPatch" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + }, + { + "value": "SecurityPatch", + "description": "AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption." + } + ] + }, + "title": "Node OS Upgrade Channel", + "description": "Manner in which the OS on your nodes is updated. The default is NodeImage." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "AzureLinux", + "Windows2019", + "Windows2022" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "title": "Whether to disable OutboundNAT in windows nodes", + "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "AgentPoolSecurityProfile": { + "type": "object", + "properties": { + "enableVTPM": { + "type": "boolean", + "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + }, + "enableSecureBoot": { + "type": "boolean", + "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + } + }, + "description": "The security settings of an agent pool." + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default." + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Application Routing add-on." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Application Routing add-on settings for the ingress profile." + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA. Default value is false.", + "default": false + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Azure Monitor addon profiles for monitoring the managed cluster.", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels." + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling." + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isDefault": { + "type": "boolean", + "description": "Whether this version is default." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "title": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable cost analysis", + "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "AgentPoolDeleteMachinesParameter": { + "type": "object", + "properties": { + "machineNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The agent pool machine names." + } + }, + "required": [ + "machineNames" + ], + "description": "Specifies a list of machine names from the agent pool to be deleted." + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}' Customers use it to create an agentpool with a specified CRG. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + }, + "Machine": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The properties of the machine" + } + }, + "type": "object" + }, + "MachineIpAddress": { + "description": "The machine IP address details.", + "properties": { + "family": { + "description": "To determine if address belongs IPv4 or IPv6 family", + "enum": [ + "IPv4", + "IPv6" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IPFamily", + "values": [ + { + "description": "IPv4 family", + "value": "IPv4" + }, + { + "description": "IPv6 family", + "value": "IPv6" + } + ] + } + }, + "ip": { + "description": "IPv4 or IPv6 address of the machine", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "MachineListResult": { + "description": "The response from the List Machines operation.", + "properties": { + "nextLink": { + "description": "The URL to get the next set of machine results.", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The list of Machines in cluster.", + "items": { + "$ref": "#/definitions/Machine" + }, + "type": "array", + "x-ms-identifiers": [ + "id" + ] + } + }, + "type": "object" + }, + "MachineNetworkProperties": { + "description": "network properties of the machine", + "properties": { + "ipAddresses": { + "description": "IPv4, IPv6 addresses of the machine", + "items": { + "$ref": "#/definitions/MachineIpAddress" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "readOnly": true, + "type": "object" + }, + "MachineProperties": { + "description": "The properties of the machine", + "properties": { + "network": { + "$ref": "#/definitions/MachineNetworkProperties" + }, + "resourceId": { + "description": "Azure resource id of the machine. It can be used to GET underlying VM Instance", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/virtualMachines" + }, + { + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines" + } + ] + }, + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + }, + "MachineNameParameter": { + "type": "string", + "description": "host name of the machine", + "name": "machineName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$", + "x-ms-parameter-location": "method" + } + } +} From e79d9ef3e065f2dcb6bd1db51e29c62a99dff5cb Mon Sep 17 00:00:00 2001 From: Alfredo Santamaria Date: Fri, 30 Aug 2024 13:32:06 -0700 Subject: [PATCH 27/30] Service Fabric Managed Clusters - API version 2024-06-01-preview (#29327) * initial commit copy from 2024-04-01 * update with api 2024-06-01-preview * add format uri * change property name to vmGalleryTags --------- Co-authored-by: Alfredo Santamaria Gomez Co-authored-by: Wes Haggard --- cSpell.json | 7 + .../ApplicationActionGetUpgrade_example.json | 17 + ...pplicationActionResumeUpgrade_example.json | 20 + ...pplicationActionStartRollback_example.json | 17 + .../ApplicationDeleteOperation_example.json | 19 + .../ApplicationGetOperation_example.json | 59 + .../ApplicationListOperation_example.json | 27 + .../ApplicationPatchOperation_example.json | 66 + .../ApplicationPutOperation_example_max.json | 156 + .../ApplicationPutOperation_example_min.json | 79 + ...cationTypeNameDeleteOperation_example.json | 19 + ...plicationTypeNameGetOperation_example.json | 22 + ...licationTypeNameListOperation_example.json | 26 + ...icationTypeNamePatchOperation_example.json | 30 + ...plicationTypeNamePutOperation_example.json | 25 + ...ionTypeVersionDeleteOperation_example.json | 20 + ...cationTypeVersionGetOperation_example.json | 24 + ...ationTypeVersionListOperation_example.json | 28 + ...tionTypeVersionPatchOperation_example.json | 32 + ...cationTypeVersionPutOperation_example.json | 45 + .../examples/DeleteNodes_example.json | 24 + .../Long_running_operation_result.json | 13 + .../Long_running_operation_status_failed.json | 23 + ...ng_running_operation_status_succeeded.json | 19 + ...gedApplyMaintenanceWindowPost_example.json | 11 + ...ManagedClusterDeleteOperation_example.json | 17 + .../ManagedClusterGetOperation_example.json | 74 + ...rListByResourceGroupOperation_example.json | 95 + ...erListBySubscriptionOperation_example.json | 94 + .../ManagedClusterPatchOperation_example.json | 109 + ...anagedClusterPutOperation_example_max.json | 489 +++ ...anagedClusterPutOperation_example_min.json | 122 + ...lusterVersionGetByEnvironment_example.json | 24 + .../ManagedClusterVersionGet_example.json | 23 + ...anagedClusterVersionListByEnvironment.json | 35 + .../ManagedClusterVersionList_example.json | 34 + ...gedMaintenanceWindowStatusGet_example.json | 22 + .../NodeTypeDeleteOperation_example.json | 18 + .../NodeTypeGetOperation_example.json | 47 + .../NodeTypeListOperation_example.json | 93 + ...deTypePatchOperationAutoScale_example.json | 87 + .../NodeTypePatchOperation_example.json | 77 + ...NodeTypePutOperationAutoScale_example.json | 201 ++ ...deTypePutOperationCustomImage_example.json | 68 + ...ionCustomSharedGalleriesImage_example.json | 68 + ...TypePutOperationDedicatedHost_example.json | 92 + ...NodeTypePutOperationStateless_example.json | 114 + ...deTypePutOperationVmImagePlan_example.json | 92 + .../NodeTypePutOperation_example_max.json | 506 +++ .../NodeTypePutOperation_example_min.json | 77 + .../NodeTypeSkusListOperation_example.json | 71 + .../examples/Operations_example.json | 95 + .../examples/ReimageNodes_UD_example.json | 21 + .../examples/ReimageNodes_example.json | 24 + .../examples/RestartNodes_example.json | 24 + .../ServiceDeleteOperation_example.json | 20 + .../examples/ServiceGetOperation_example.json | 39 + .../ServiceListOperation_example.json | 40 + .../ServicePatchOperation_example.json | 77 + .../ServicePutOperation_example_max.json | 192 ++ .../ServicePutOperation_example_min.json | 60 + .../managedAzResiliencyStatusGet_example.json | 34 + .../managedUnsupportedVMSizesGet_example.json | 20 + ...managedUnsupportedVMSizesList_example.json | 175 + .../managedapplication.json | 3040 +++++++++++++++++ .../2024-06-01-preview/managedcluster.json | 2379 +++++++++++++ .../preview/2024-06-01-preview/nodetype.json | 2091 ++++++++++++ .../resource-manager/readme.md | 13 +- 68 files changed, 11920 insertions(+), 1 deletion(-) create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionGetUpgrade_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionResumeUpgrade_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionStartRollback_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePutOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPutOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/DeleteNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_result.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_failed.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_succeeded.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedApplyMaintenanceWindowPost_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionListByEnvironment.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionList_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedMaintenanceWindowStatusGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperationAutoScale_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationAutoScale_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomImage_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationStateless_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeSkusListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Operations_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_UD_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/RestartNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedAzResiliencyStatusGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesList_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedapplication.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedcluster.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/nodetype.json diff --git a/cSpell.json b/cSpell.json index 187a91386db8..fd37bd220726 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1397,6 +1397,13 @@ "mqttbroker", "schemaregistry" ] + }, + { + "filename": "**/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/**/*.json", + "words": [ + "sfmc", + "sfmc's" + ] } ], "enableFiletypes": [ diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionGetUpgrade_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionGetUpgrade_example.json new file mode 100644 index 000000000000..5ae21a407899 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionGetUpgrade_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionResumeUpgrade_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionResumeUpgrade_example.json new file mode 100644 index 000000000000..8db66eec98eb --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionResumeUpgrade_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview", + "parameters": { + "upgradeDomainName": "UD1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionStartRollback_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionStartRollback_example.json new file mode 100644 index 000000000000..5ae21a407899 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationActionStartRollback_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationDeleteOperation_example.json new file mode 100644 index 000000000000..52c71d43960e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/76053752-a423-4a80-b283-1dad1ba5f314?api-version=2024-06-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationGetOperation_example.json new file mode 100644 index 000000000000..b34cd29fa101 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationGetOperation_example.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationListOperation_example.json new file mode 100644 index 000000000000..f4b078096c44 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationListOperation_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPatchOperation_example.json new file mode 100644 index 000000000000..c4bc1d251ebe --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPatchOperation_example.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_max.json new file mode 100644 index 000000000000..a5cfa100db18 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_max.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_min.json new file mode 100644 index 000000000000..0683bacfc76b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationPutOperation_example_min.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5dce62ce-439b-47af-81d8-99ab14708e91?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myCluster", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json new file mode 100644 index 000000000000..a6f49040e107 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/6a367b2d-9f60-4941-b886-e348ddcb4127?api-version=2024-06-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameGetOperation_example.json new file mode 100644 index 000000000000..5bdf40984ad1 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameGetOperation_example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameListOperation_example.json new file mode 100644 index 000000000000..460fec4cc690 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNameListOperation_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePatchOperation_example.json new file mode 100644 index 000000000000..bb66c43a13dc --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePatchOperation_example.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2024-06-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePutOperation_example.json new file mode 100644 index 000000000000..246260c9a09d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeNamePutOperation_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json new file mode 100644 index 000000000000..9729bc574e60 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/28e62369-ed8c-4aba-8c05-ab7d6238cc3d?api-version=2024-06-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionGetOperation_example.json new file mode 100644 index 000000000000..925b4321f860 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionGetOperation_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionListOperation_example.json new file mode 100644 index 000000000000..6822dddd1d82 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionListOperation_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json new file mode 100644 index 000000000000..21fd85a1d83e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2024-06-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPutOperation_example.json new file mode 100644 index 000000000000..2d3d62a177c9 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ApplicationTypeVersionPutOperation_example.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Creating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/e2413c7e-d51b-40ac-8155-bc85bf8ae856?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/DeleteNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/DeleteNodes_example.json new file mode 100644 index 000000000000..031a95916563 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/DeleteNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_result.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_result.json new file mode 100644 index 000000000000..9ed8dfb0a816 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_result.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-06-01-preview", + "operationId": "00000000-0000-0000-0000-000000001234" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_failed.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_failed.json new file mode 100644 index 000000000000..9b31c08878fb --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_failed.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-06-01-preview", + "operationId": "00000000-0000-0000-0000-000000001234" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000001234", + "startTime": "2022-01-03T23:58:02.2501337Z", + "endTime": "2022-01-04T00:13:03.2790951Z", + "percentComplete": 100.0, + "status": "Failed", + "error": { + "code": "-2146233029", + "message": "A task was canceled." + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_succeeded.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_succeeded.json new file mode 100644 index 000000000000..3ad5434ebc5e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Long_running_operation_status_succeeded.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-06-01-preview", + "operationId": "00000000-0000-0000-0000-000000001234" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000001234", + "startTime": "2022-01-03T23:58:02.2501337Z", + "endTime": "2022-01-04T00:13:03.2790951Z", + "percentComplete": 100.0, + "status": "Succeeded" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedApplyMaintenanceWindowPost_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedApplyMaintenanceWindowPost_example.json new file mode 100644 index 000000000000..80632bce6f9b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedApplyMaintenanceWindowPost_example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "clusterName": "mycluster1", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterDeleteOperation_example.json new file mode 100644 index 000000000000..4f3a23d7f5f8 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterDeleteOperation_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterGetOperation_example.json new file mode 100644 index 000000000000..63fa6063ff59 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterGetOperation_example.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json new file mode 100644 index 000000000000..d11b53cf2416 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json new file mode 100644 index 000000000000..a4338117ab3d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPatchOperation_example.json new file mode 100644 index 000000000000..045b9906f5fc --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPatchOperation_example.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2024-06-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19001, + "httpGatewayConnectionPort": 19081, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "false" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_max.json new file mode 100644 index 000000000000..a3c576306bea --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_max.json @@ -0,0 +1,489 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "mycluster", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus", + "tags": {}, + "sku": { + "name": "Basic" + }, + "properties": { + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "dnsName": "mycluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http", + "loadDistribution": "Default" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "zonalUpdateMode": "Fast", + "enableIpv6": true, + "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix", + "publicIPv6PrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPv6Prefix", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ], + "useCustomVnet": true, + "ddosProtectionPlanId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/ddosProtectionPlans/myDDoSProtectionPlan", + "upgradeDescription": { + "forceRestart": false, + "monitoringPolicy": { + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:45:00", + "healthCheckRetryTimeout": "00:55:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "03:00:00" + }, + "healthPolicy": { + "maxPercentUnhealthyNodes": 10, + "maxPercentUnhealthyApplications": 30 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 20, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 40, + "maxPercentDeltaUnhealthyApplications": 40 + } + }, + "httpGatewayTokenAuthConnectionPort": 19081, + "enableHttpGatewayExclusiveAuthMode": true, + "autoGeneratedDomainNameLabelScope": "SubscriptionReuse" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "mycluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "mycluster", + "fqdn": "mycluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp", + "loadDistribution": "Default" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "zonalUpdateMode": "Fast", + "enableIpv6": true, + "enableServicePublicIP": true, + "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix", + "publicIPv6PrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPv6Prefix", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ], + "useCustomVnet": true, + "ddosProtectionPlanId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/ddosProtectionPlans/myDDoSProtectionPlan", + "upgradeDescription": { + "forceRestart": false, + "monitoringPolicy": { + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:45:00", + "healthCheckRetryTimeout": "00:55:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "03:00:00" + }, + "healthPolicy": { + "maxPercentUnhealthyNodes": 10, + "maxPercentUnhealthyApplications": 30 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 20, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 40, + "maxPercentDeltaUnhealthyApplications": 40 + } + }, + "httpGatewayTokenAuthConnectionPort": 19081, + "enableHttpGatewayExclusiveAuthMode": true, + "customFqdn": "mycluster.abcdefghijk.eastus.sfmc.io", + "autoGeneratedDomainNameLabelScope": "SubscriptionReuse" + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "mycluster", + "fqdn": "mycluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp", + "loadDistribution": "Default" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "zonalUpdateMode": "Fast", + "enableIpv6": true, + "enableServicePublicIP": true, + "ipv6Address": "0000:0000:0000:0000:0000:0000:0000:0000", + "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix", + "publicIPv6PrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPv6Prefix", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ], + "useCustomVnet": true, + "ddosProtectionPlanId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/ddosProtectionPlans/myDDoSProtectionPlan", + "upgradeDescription": { + "forceRestart": false, + "monitoringPolicy": { + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:45:00", + "healthCheckRetryTimeout": "00:55:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "03:00:00" + }, + "upgradeReplicaSetCheckTimeout": "49710.06:28:16", + "healthPolicy": { + "maxPercentUnhealthyNodes": 10, + "maxPercentUnhealthyApplications": 30 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 20, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 40, + "maxPercentDeltaUnhealthyApplications": 40 + } + }, + "httpGatewayTokenAuthConnectionPort": 19081, + "enableHttpGatewayExclusiveAuthMode": true, + "customFqdn": "mycluster.abcdefghijk.eastus.sfmc.io", + "autoGeneratedDomainNameLabelScope": "SubscriptionReuse" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_min.json new file mode 100644 index 000000000000..6cc4470f9941 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterPutOperation_example_min.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "dnsName": "myCluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json new file mode 100644 index 000000000000..424b30c12360 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "7.2.477.9590", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGet_example.json new file mode 100644 index 000000000000..c7e1756e0066 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionGet_example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "7.2.477.9590", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionListByEnvironment.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionListByEnvironment.json new file mode 100644 index 000000000000..20bdb4228caa --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionListByEnvironment.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionList_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionList_example.json new file mode 100644 index 000000000000..9c002b9781af --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedClusterVersionList_example.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedMaintenanceWindowStatusGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedMaintenanceWindowStatusGet_example.json new file mode 100644 index 000000000000..014eadc46d58 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ManagedMaintenanceWindowStatusGet_example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "clusterName": "mycluster1", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isWindowEnabled": false, + "isRegionReady": true, + "isWindowActive": true, + "canApplyUpdates": true, + "lastWindowStatusUpdateAtUTC": "2023-04-30T00:00:00", + "lastWindowStartTimeUTC": "2023-04-30T00:00:00", + "lastWindowEndTimeUTC": "2023-04-30T00:00:00" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeDeleteOperation_example.json new file mode 100644 index 000000000000..323d5d907f06 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeDeleteOperation_example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeGetOperation_example.json new file mode 100644 index 000000000000..2db1a950192e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeGetOperation_example.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "FE", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeListOperation_example.json new file mode 100644 index 000000000000..d0bb5d6464ea --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeListOperation_example.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "sku": { + "name": "Standard_P0", + "tier": "Standard", + "capacity": 5 + }, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperationAutoScale_example.json new file mode 100644 index 000000000000..c2a6905ee6c5 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperationAutoScale_example.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperation_example.json new file mode 100644 index 000000000000..7690b8fb4ed0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationAutoScale_example.json new file mode 100644 index 000000000000..de85d08bfb9c --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationAutoScale_example.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": -1, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomImage_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomImage_example.json new file mode 100644 index 000000000000..5837614f6e10 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomImage_example.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImageResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/galleries/myCustomImages/images/Win2019DC", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImageResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/galleries/myCustomImages/images/Win2019DC", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImageResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/galleries/myCustomImages/images/Win2019DC", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json new file mode 100644 index 000000000000..e92cd9f08763 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmSharedGalleryImageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/sharedGalleries/35349201-a0b3-405e-8a23-9f1450984307-SFSHAREDGALLERY/images/TestNoProdContainerDImage/versions/latest", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmSharedGalleryImageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/sharedGalleries/35349201-a0b3-405e-8a23-9f1450984307-SFSHAREDGALLERY/images/TestNoProdContainerDImage/versions/latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmSharedGalleryImageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/sharedGalleries/35349201-a0b3-405e-8a23-9f1450984307-SFSHAREDGALLERY/images/TestNoProdContainerDImage/versions/latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json new file mode 100644 index 000000000000..0f2daa2721b0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D8s_v3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2019-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "zones": [ + "1" + ], + "hostGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testhostgroupRG/providers/Microsoft.Compute/hostGroups/testHostGroup" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D8s_v3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2019-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "zones": [ + "1" + ], + "hostGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testhostgroupRG/providers/Microsoft.Compute/hostGroups/testHostGroup", + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D8s_v3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2019-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "zones": [ + "1" + ], + "hostGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testhostgroupRG/providers/Microsoft.Compute/hostGroups/testHostGroup", + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationStateless_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationStateless_example.json new file mode 100644 index 000000000000..950e870c9ba1 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationStateless_example.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "useTempDataDisk": true, + "multiplePlacementGroups": true, + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "useTempDataDisk": true, + "multiplePlacementGroups": true, + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "useTempDataDisk": true, + "multiplePlacementGroups": true, + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json new file mode 100644 index 000000000000..dbd8646e531e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImagePublisher": "testpublisher", + "vmImageOffer": "windows_2022_test", + "vmImageSku": "win_2022_test_20_10_gen2", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "vmImagePlan": { + "name": "win_2022_test_20_10_gen2", + "publisher": "testpublisher", + "product": "windows_2022_test" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "testpublisher", + "vmImageOffer": "windows_2022_test", + "vmImageSku": "win_2022_test_20_10_gen2", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmImagePlan": { + "name": "win_2022_test_20_10_gen2", + "publisher": "testpublisher", + "product": "windows_2022_test" + } + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "testpublisher", + "vmImageOffer": "windows_2022_test", + "vmImageSku": "win_2022_test_20_10_gen2", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmImagePlan": { + "name": "win_2022_test_20_10_gen2", + "publisher": "testpublisher", + "product": "windows_2022_test" + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_max.json new file mode 100644 index 000000000000..9ae61f202aa8 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_max.json @@ -0,0 +1,506 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE-testResourceGroup-testRegion-test", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "computerNamePrefix": "BE", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "isSpotVM": true, + "useEphemeralOSDisk": true, + "spotRestoreTimeout": "PT30M", + "evictionPolicy": "Deallocate", + "enableOverProvisioning": false, + "multiplePlacementGroups": true, + "securityType": "TrustedLaunch", + "secureBootEnabled": true, + "enableNodePublicIP": true, + "enableNodePublicIPv6": true, + "natGatewayId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/natGateways/myNatGateway", + "serviceArtifactReferenceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/myVmArtifactProfile", + "dscpConfigurationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/dscpConfigurations/myDscpConfig", + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {}, + "setupOrder": [ + "BeforeSFRuntime" + ] + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool", + "applicationGatewayBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "useDefaultPublicLoadBalancer": true, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmSetupActions": [ + "EnableContainers", + "EnableHyperV" + ], + "additionalNetworkInterfaceConfigurations": [ + { + "name": "nic-1", + "enableAcceleratedNetworking": true, + "dscpConfiguration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/dscpConfigurations/myDscpConfig" + }, + "ipConfigurations": [ + { + "name": "ipconfig-1", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool" + } + ], + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "privateIPAddressVersion": "IPv4", + "publicIPAddressConfiguration": { + "name": "publicip-1", + "ipTags": [ + { + "ipTagType": "RoutingPreference", + "tag": "Internet" + } + ], + "publicIPAddressVersion": "IPv4" + } + } + ] + } + ], + "vmApplications": [ + { + "configurationReference": "https://mystorageaccount.blob.core.windows.net/containername/blobname", + "enableAutomaticUpgrade": true, + "order": 1, + "packageReferenceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Compute/galleries/myGallery/applications/myApplication/versions/1.0.0", + "vmGalleryTags": "{\"Tag1\":\"Value1\",\"Tag2\":\"Value2\"}", + "treatFailureAsDeploymentFailure": false + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "isSpotVM": true, + "useEphemeralOSDisk": true, + "spotRestoreTimeout": "PT30M", + "evictionPolicy": "Deallocate", + "enableOverProvisioning": false, + "multiplePlacementGroups": true, + "securityType": "TrustedLaunch", + "secureBootEnabled": true, + "enableNodePublicIP": true, + "enableNodePublicIPv6": true, + "natGatewayId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/natGateways/myNatGateway", + "serviceArtifactReferenceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/myVmArtifactProfile", + "dscpConfigurationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/dscpConfigurations/myDscpConfig", + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {}, + "setupOrder": [ + "BeforeSFRuntime" + ] + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool", + "applicationGatewayBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "useDefaultPublicLoadBalancer": true, + "zones": [ + "1", + "2", + "3" + ], + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmSetupActions": [ + "EnableContainers", + "EnableHyperV" + ], + "additionalNetworkInterfaceConfigurations": [ + { + "name": "nic-1", + "enableAcceleratedNetworking": true, + "dscpConfiguration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/dscpConfigurations/myDscpConfig" + }, + "ipConfigurations": [ + { + "name": "ipconfig-1", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool" + } + ], + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "privateIPAddressVersion": "IPv4", + "publicIPAddressConfiguration": { + "name": "publicip-1", + "ipTags": [ + { + "ipTagType": "RoutingPreference", + "tag": "Internet" + } + ], + "publicIPAddressVersion": "IPv4" + } + } + ] + } + ], + "vmApplications": [ + { + "configurationReference": "https://mystorageaccount.blob.core.windows.net/containername/blobname", + "enableAutomaticUpgrade": true, + "order": 1, + "packageReferenceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Compute/galleries/myGallery/applications/myApplication/versions/1.0.0", + "vmGalleryTags": "{\"Tag1\":\"Value1\",\"Tag2\":\"Value2\"}", + "treatFailureAsDeploymentFailure": false + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "isSpotVM": true, + "useEphemeralOSDisk": true, + "spotRestoreTimeout": "PT30M", + "evictionPolicy": "Deallocate", + "enableOverProvisioning": false, + "multiplePlacementGroups": true, + "securityType": "TrustedLaunch", + "secureBootEnabled": true, + "enableNodePublicIP": true, + "enableNodePublicIPv6": true, + "natGatewayId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/natGateways/myNatGateway", + "serviceArtifactReferenceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/myVmArtifactProfile", + "dscpConfigurationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/dscpConfigurations/myDscpConfig", + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {}, + "setupOrder": [ + "BeforeSFRuntime" + ] + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool", + "applicationGatewayBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "useDefaultPublicLoadBalancer": true, + "zones": [ + "1", + "2", + "3" + ], + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmSetupActions": [ + "EnableContainers", + "EnableHyperV" + ], + "additionalNetworkInterfaceConfigurations": [ + { + "name": "nic-1", + "enableAcceleratedNetworking": true, + "dscpConfiguration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/dscpConfigurations/myDscpConfig" + }, + "ipConfigurations": [ + { + "name": "ipconfig-1", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool" + } + ], + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "privateIPAddressVersion": "IPv4", + "publicIPAddressConfiguration": { + "name": "publicip-1", + "ipTags": [ + { + "ipTagType": "RoutingPreference", + "tag": "Internet" + } + ], + "publicIPAddressVersion": "IPv4" + } + } + ] + } + ], + "vmApplications": [ + { + "configurationReference": "https://mystorageaccount.blob.core.windows.net/containername/blobname", + "enableAutomaticUpgrade": true, + "order": 1, + "packageReferenceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Compute/galleries/myGallery/applications/myApplication/versions/1.0.0", + "vmGalleryTags": "{\"Tag1\":\"Value1\",\"Tag2\":\"Value2\"}", + "treatFailureAsDeploymentFailure": false + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_min.json new file mode 100644 index 000000000000..29bd57bea7c3 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypePutOperation_example_min.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeSkusListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeSkusListOperation_example.json new file mode 100644 index 000000000000..03b16a75e5f6 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/NodeTypeSkusListOperation_example.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S0", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 100, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 300, + "default": 3, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 1000, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 1000, + "default": 3, + "scaleType": "Automatic" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Operations_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Operations_example.json new file mode 100644 index 000000000000..71c067107ad3 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/Operations_example.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceFabric/managedClusters/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Read Cluster", + "description": "Read any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Create or Update Cluster", + "description": "Create or Update any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Delete Cluster", + "description": "Delete any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Read Node type", + "description": "Read any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Create or Update Node type", + "description": "Create or Update any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete Node type", + "description": "Delete any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/restart/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Restart nodes from Node type", + "description": "Restart nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/reimage/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Reimage nodes from Node type", + "description": "Reimage nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/deleteNode/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete nodes from Node type", + "description": "Delete nodes from Node type" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_UD_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_UD_example.json new file mode 100644 index 000000000000..89fcbef9cd4c --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_UD_example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "updateType": "ByUpgradeDomain" + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_example.json new file mode 100644 index 000000000000..031a95916563 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ReimageNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/RestartNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/RestartNodes_example.json new file mode 100644 index 000000000000..031a95916563 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/RestartNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2024-06-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-06-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceDeleteOperation_example.json new file mode 100644 index 000000000000..6fd2f4a001be --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/41fa5ef9-7f34-4c36-a730-93e0bb757d22?api-version=2024-06-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceGetOperation_example.json new file mode 100644 index 000000000000..eaf47f59055b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceGetOperation_example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceListOperation_example.json new file mode 100644 index 000000000000..1ebd2530448b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServiceListOperation_example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1, + "servicePackageActivationMode": "SharedProcess" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePatchOperation_example.json new file mode 100644 index 000000000000..d339ed326420 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2024-06-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_max.json new file mode 100644 index 000000000000..29019c6e418b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_max.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "serviceDnsName": "myservicednsname.myApp", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "serviceDnsName": "myservicednsname.myApp", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/2e633105-aadc-4928-9164-d76b974170a3?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "serviceDnsName": "myservicednsname.myApp", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_min.json new file mode 100644 index 000000000000..405c1e18220a --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/ServicePutOperation_example_min.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2024-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5bc615c3-6c5b-4593-80e1-008f55376ec7?api-version=2024-06-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedAzResiliencyStatusGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedAzResiliencyStatusGet_example.json new file mode 100644 index 000000000000..51479fa94a62 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedAzResiliencyStatusGet_example.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "clusterName": "mycluster1", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "baseResourceStatus": [ + { + "resourceName": "mycluster1storage", + "resourceType": "Microsoft.Storage/storageaccounts", + "isZoneResilient": false + }, + { + "resourceName": "PublicIP-mycluster1", + "resourceType": "Microsoft.Network/publicIPAddress", + "isZoneResilient": true + }, + { + "resourceName": "Primary", + "resourceType": "Microsoft.Compute/virtualmachinescalesets", + "isZoneResilient": false, + "details": "Status: InProgress, ZonalNodes: 3, RegionalNodes: 3" + } + ], + "isClusterZoneResilient": false + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesGet_example.json new file mode 100644 index 000000000000..685e0d675268 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesGet_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-06-01-preview", + "vmSize": "Standard_B1ls1" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ls1", + "name": "Standard_B1ls1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ls1" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesList_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesList_example.json new file mode 100644 index 000000000000..4cbd212814a2 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/examples/managedUnsupportedVMSizesList_example.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ls1", + "name": "Standard_B1ls1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ls1" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1s", + "name": "Standard_B1s", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1s" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ms", + "name": "Standard_B1ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B2s", + "name": "Standard_B2s", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B2s" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B2ms", + "name": "Standard_B2ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B2ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B4ms", + "name": "Standard_B4ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B4ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B8ms", + "name": "Standard_B8ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B8ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A1_v2", + "name": "Standard_A1_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A1_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A2_v2", + "name": "Standard_A2_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A2_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A4_v2", + "name": "Standard_A4_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A4_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A8_v2", + "name": "Standard_A8_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A8_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A2m_v2", + "name": "Standard_A2m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A2m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A4m_v2", + "name": "Standard_A4m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A4m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A8m_v2", + "name": "Standard_A8m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A8m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A0", + "name": "Basic_A0", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A0" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A1", + "name": "Basic_A1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A1" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A2", + "name": "Basic_A2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A3", + "name": "Basic_A3", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A3" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A4", + "name": "Basic_A4", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A4" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A0", + "name": "Standard_A0", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A0" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedapplication.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedapplication.json new file mode 100644 index 000000000000..da43f59a8e44 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedapplication.json @@ -0,0 +1,3040 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2024-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Get", + "summary": "Gets a Service Fabric managed application type name resource.", + "description": "Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type": { + "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type name resource.", + "description": "Create or update a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type name resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type": { + "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Update", + "summary": "Updates the tags of an application type resource of a given managed cluster.", + "description": "Updates the tags of an application type resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type": { + "$ref": "./examples/ApplicationTypeNamePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Delete", + "summary": "Deletes a Service Fabric managed application type name resource.", + "description": "Delete a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type": { + "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_List", + "summary": "Gets the list of application type name resources created in the specified Service Fabric managed cluster resource.", + "description": "Gets all application type name resources created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type name resources": { + "$ref": "./examples/ApplicationTypeNameListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Get", + "summary": "Gets a Service Fabric managed application type version resource.", + "description": "Get a Service Fabric managed application type version resource created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type version": { + "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type version resource.", + "description": "Create or update a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type version": { + "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Update", + "summary": "Updates the tags of an application type version resource of a given managed cluster.", + "description": "Updates the tags of an application type version resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type version": { + "$ref": "./examples/ApplicationTypeVersionPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Delete", + "summary": "Deletes a Service Fabric managed application type version resource.", + "description": "Delete a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type version": { + "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_ListByApplicationTypes", + "summary": "Gets the list of application type version resources created in the specified Service Fabric managed application type name resource.", + "description": "Gets all application type version resources created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/fetchUpgradeStatus": { + "post": { + "tags": [ + "Application" + ], + "operationId": "Applications_ReadUpgrade", + "summary": "Get the status of the latest application upgrade.", + "description": "Get the status of the latest application upgrade. It will query the cluster to find the status of the latest application upgrade.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application upgrade": { + "$ref": "./examples/ApplicationActionGetUpgrade_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The operation was accepted.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/startRollback": { + "post": { + "tags": [ + "Application" + ], + "operationId": "Applications_StartRollback", + "summary": "Send a request to start a rollback of the current application upgrade.", + "description": "Send a request to start a rollback of the current application upgrade. This will start rolling back the application to the previous version.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Start an application upgrade rollback": { + "$ref": "./examples/ApplicationActionStartRollback_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The operation was accepted.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/resumeUpgrade": { + "post": { + "tags": [ + "Application" + ], + "operationId": "Applications_ResumeUpgrade", + "summary": "Send a request to resume the current application upgrade.", + "description": "Send a request to resume the current application upgrade. This will resume the application upgrade from where it was paused.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for resuming an application upgrade.", + "required": true, + "schema": { + "$ref": "#/definitions/RuntimeResumeApplicationUpgradeParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Resume upgrade": { + "$ref": "./examples/ApplicationActionResumeUpgrade_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The operation was accepted.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "summary": "Gets a Service Fabric managed application resource.", + "description": "Get a Service Fabric managed application resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application": { + "$ref": "./examples/ApplicationGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application resource.", + "description": "Create or update a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application with minimum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_min.json" + }, + "Put an application with maximum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "summary": "Updates the tags of an application resource of a given managed cluster.", + "description": "Updates the tags of an application resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application": { + "$ref": "./examples/ApplicationPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "summary": "Deletes a Service Fabric managed application resource.", + "description": "Delete a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application": { + "$ref": "./examples/ApplicationDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "summary": "Gets the list of managed application resources created in the specified Service Fabric cluster resource.", + "description": "Gets all managed application resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application resources": { + "$ref": "./examples/ApplicationListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_Get", + "summary": "Gets a Service Fabric managed service resource.", + "description": "Get a Service Fabric service resource created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a service": { + "$ref": "./examples/ServiceGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Services_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed service resource.", + "description": "Create or update a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a service with minimum parameters": { + "$ref": "./examples/ServicePutOperation_example_min.json" + }, + "Put a service with maximum parameters": { + "$ref": "./examples/ServicePutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Services" + ], + "operationId": "Services_Update", + "summary": "Updates the tags of a service resource of a given managed cluster.", + "description": "Updates the tags of a service resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch a service": { + "$ref": "./examples/ServicePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Service" + ], + "operationId": "Services_Delete", + "summary": "Deletes a Service Fabric managed service resource.", + "description": "Delete a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a service": { + "$ref": "./examples/ServiceDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_ListByApplications", + "summary": "Gets the list of service resources created in the specified Service Fabric managed application resource.", + "description": "Gets all service resources created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of service resources": { + "$ref": "./examples/ServiceListOperation_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "RuntimeFailureAction": { + "type": "string", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nRollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.\n", + "enum": [ + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Rollback", + "description": "The upgrade will start rolling back automatically. The value is 0" + }, + { + "value": "Manual", + "description": "The upgrade will switch to UnmonitoredManual upgrade mode. The value is 1" + } + ] + } + }, + "RuntimeResumeApplicationUpgradeParameters": { + "type": "object", + "properties": { + "upgradeDomainName": { + "description": "The upgrade domain name. Expected to be the next upgrade domain if the application is upgrading.", + "type": "string" + } + }, + "description": "Parameters for Resume Upgrade action. The upgrade domain name must be specified." + }, + "RuntimeUpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.", + "enum": [ + "UnmonitoredAuto", + "UnmonitoredManual", + "Monitored" + ], + "default": "Monitored", + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 0" + }, + { + "value": "UnmonitoredManual", + "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 1" + }, + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 2" + } + ] + } + }, + "AddRemoveIncrementalNamedPartitionScalingMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "AddRemoveIncrementalNamedPartitionScalingMechanism" + } + ], + "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", + "required": [ + "minPartitionCount", + "maxPartitionCount", + "scaleIncrement" + ], + "properties": { + "minPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of named partitions of the service." + }, + "maxPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of named partitions of the service." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "required": [ + "considerWarningAsError", + "maxPercentUnhealthyDeployedApplications" + ], + "properties": { + "considerWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors." + }, + "maxPercentUnhealthyDeployedApplications": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" + }, + "defaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "serviceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationParameterList": { + "type": "object", + "description": "List of application parameters with overridden values from their default values specified in the application manifest.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationResource": { + "type": "object", + "description": "The application resource.", + "properties": { + "identity": { + "$ref": "#/definitions/ManagedIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceList": { + "type": "object", + "description": "The list of application resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationResourceProperties": { + "type": "object", + "description": "The application resource properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "version": { + "$ref": "#/definitions/ApplicationTypeVersion" + }, + "parameters": { + "$ref": "#/definitions/ApplicationParameterList" + }, + "upgradePolicy": { + "$ref": "#/definitions/ApplicationUpgradePolicy" + }, + "managedIdentities": { + "description": "List of user assigned identities for the application, each mapped to a friendly name.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationUserAssignedIdentity" + }, + "x-ms-identifiers": [] + } + } + }, + "ApplicationTypeResource": { + "type": "object", + "description": "The application type name resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeResourceList": { + "type": "object", + "description": "The list of application type names.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeResourceProperties": { + "type": "object", + "description": "The application type name properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ApplicationTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type update request" + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest.\nThis name must be the full Arm Resource ID for the referenced application type version.\n" + }, + "ApplicationTypeVersionResource": { + "type": "object", + "description": "An application type version resource for the specified application type name resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeVersionResourceList": { + "type": "object", + "description": "The list of application type version resources for the specified application type name resource.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type version list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeVersionResourceProperties": { + "type": "object", + "description": "The properties of the application type version resource.", + "required": [ + "appPackageUrl" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + } + } + }, + "ApplicationTypeVersionUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type version update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type version update request" + }, + "ApplicationUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application update request" + }, + "ApplicationUpgradePolicy": { + "type": "object", + "description": "Describes the policy for a monitored application upgrade.", + "properties": { + "applicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy" + }, + "forceRestart": { + "$ref": "#/definitions/ForceRestart" + }, + "rollingUpgradeMonitoringPolicy": { + "$ref": "#/definitions/RollingUpgradeMonitoringPolicy" + }, + "instanceCloseDelayDuration": { + "type": "integer", + "format": "int64", + "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description." + }, + "upgradeMode": { + "$ref": "#/definitions/RollingUpgradeMode" + }, + "upgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "recreateApplication": { + "type": "boolean", + "description": "Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed." + } + } + }, + "ApplicationUserAssignedIdentity": { + "type": "object", + "required": [ + "name", + "principalId" + ], + "properties": { + "name": { + "type": "string", + "description": "The friendly name of user assigned identity." + }, + "principalId": { + "type": "string", + "description": "The principal id of user assigned identity." + } + } + }, + "AveragePartitionLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AveragePartitionLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AveragePartitionLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "AverageServiceLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AverageServiceLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AverageServiceLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval", + "useOnlyPrimaryLoad" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + }, + "useOnlyPrimaryLoad": { + "type": "boolean", + "description": "Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service." + } + } + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelation" + }, + "x-ms-identifiers": [ + "serviceName" + ], + "description": "A list that describes the correlation of the service with other services." + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckStableDuration": { + "type": "string", + "x-ms-format": "duration-constant", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckWaitDuration": { + "type": "string", + "x-ms-format": "duration-constant", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "ManagedIdentity": { + "type": "object", + "description": "Describes the managed identities for an Azure resource.", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of the managed identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "The tenant id of the managed identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentityMap" + } + } + }, + "ManagedIdentityType": { + "type": "string", + "description": "The type of managed identity for the resource.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Indicates that no identity is associated with the resource." + }, + { + "value": "SystemAssigned", + "description": "Indicates that system assigned identity is associated with the resource." + }, + { + "value": "UserAssigned", + "description": "Indicates that user assigned identity is associated with the resource." + }, + { + "value": "SystemAssigned, UserAssigned", + "description": "Indicates that both system assigned and user assigned identity are associated with the resource." + } + ] + } + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "NamedPartitionScheme": { + "type": "object", + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "NamedPartitionScheme" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "names" + ], + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array for the names of the partitions." + } + } + }, + "Partition": { + "type": "object", + "discriminator": "partitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "partitionScheme" + ], + "properties": { + "partitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "PartitionInstanceCountScaleMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "PartitionInstanceCountScaleMechanism" + } + ], + "x-ms-discriminator-value": "ScalePartitionInstanceCount", + "required": [ + "minInstanceCount", + "maxInstanceCount", + "scaleIncrement" + ], + "properties": { + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of instances of the partition." + }, + "maxInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of instances of the partition." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2." + } + ] + } + }, + "ProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location depends on the parent resource.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "RollingUpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto.", + "enum": [ + "Monitored", + "UnmonitoredAuto" + ], + "x-ms-enum": { + "name": "RollingUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0." + }, + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1." + } + ] + } + }, + "RollingUpgradeMonitoringPolicy": { + "type": "object", + "description": "The policy used for monitoring the application upgrade", + "required": [ + "failureAction", + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout" + ], + "properties": { + "failureAction": { + "type": "string", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", + "enum": [ + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Rollback", + "description": "Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails." + }, + { + "value": "Manual", + "description": "Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically." + } + ] + } + }, + "healthCheckWaitDuration": { + "$ref": "#/definitions/HealthCheckWaitDuration" + }, + "healthCheckStableDuration": { + "$ref": "#/definitions/HealthCheckStableDuration" + }, + "healthCheckRetryTimeout": { + "$ref": "#/definitions/HealthCheckRetryTimeout" + }, + "upgradeTimeout": { + "$ref": "#/definitions/UpgradeTimeout" + }, + "upgradeDomainTimeout": { + "$ref": "#/definitions/UpgradeDomainTimeout" + } + } + }, + "ScalingMechanism": { + "type": "object", + "discriminator": "kind", + "description": "Describes the mechanism for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingMechanismKind", + "description": "Specifies the mechanism associated with this scaling policy." + } + } + }, + "ScalingPolicy": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "scalingMechanism", + "scalingTrigger" + ], + "properties": { + "scalingMechanism": { + "$ref": "#/definitions/ScalingMechanism", + "description": "Specifies the mechanism associated with this scaling policy" + }, + "scalingTrigger": { + "$ref": "#/definitions/ScalingTrigger", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ScalingPolicyList": { + "type": "array", + "items": { + "$ref": "#/definitions/ScalingPolicy" + }, + "x-ms-identifiers": [], + "description": "Scaling policies for this service." + }, + "ScalingTrigger": { + "type": "object", + "discriminator": "kind", + "description": "Describes the trigger for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingTriggerKind", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ServiceCorrelation": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "scheme", + "serviceName" + ], + "properties": { + "scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "serviceName": { + "$ref": "#/definitions/ServiceName", + "description": "The Arm Resource ID of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 0." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 1." + } + ] + } + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 0." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1." + } + ] + } + }, + "ServiceLoadMetric": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "primaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "secondaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "defaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetric" + }, + "x-ms-identifiers": [], + "description": "The service load metrics is given as an array of ServiceLoadMetric objects." + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServiceName": { + "type": "string", + "description": "The full ARM Resource ID describing the service resource", + "x-sf-clientlib": { + "typeName": "ServiceName" + } + }, + "ServicePlacementInvalidDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementInvalidDomainPolicy" + } + ], + "x-ms-discriminator-value": "InvalidDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should not be used for placement." + } + } + }, + "ServicePlacementNonPartiallyPlaceServicePolicy": { + "type": "object", + "description": "The name of the domain that should used for placement as per this policy.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementNonPartiallyPlaceServicePolicy" + } + ], + "x-ms-discriminator-value": "NonPartiallyPlaceService" + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + "x-ms-identifiers": [], + "description": "A list that describes the correlation of the service with other services." + }, + "ServicePlacementPolicy": { + "type": "object", + "discriminator": "type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/definitions/ServicePlacementPolicyType" + } + } + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 0." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 1." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 2." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 3." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 4." + } + ] + } + }, + "ServicePlacementPreferPrimaryDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the service's \nPrimary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric\ncluster is geographically distributed in order to indicate that a service's primary replica should\nbe located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional\nor datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica\nmay not end up located in this domain due to failures, capacity limits, or other constraints.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementPreferPrimaryDomainPolicy" + } + ], + "x-ms-discriminator-value": "PreferredPrimaryDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequiredDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequiredDomainPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequireDomainDistributionPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas\nfrom the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures\ndue to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider\na case where replicas are deployed across different data center, with one replica per location.\nIn the event that one of the datacenters goes offline, normally the replica that was placed in that\ndatacenter will be packed into one of the remaining datacenters. If this is not desirable then this\npolicy should be set.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequireDomainDistributionPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomainDistribution", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServiceResource": { + "type": "object", + "description": "The service resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceList": { + "type": "object", + "description": "The list of service resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of service list results if there are any.", + "readOnly": true + } + } + }, + "ServiceResourceProperties": { + "type": "object", + "description": "The service resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind", + "serviceTypeName", + "partitionDescription" + ], + "discriminator": "serviceKind", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "serviceKind": { + "$ref": "#/definitions/ServiceKind" + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "$ref": "#/definitions/Partition" + }, + "servicePackageActivationMode": { + "type": "string", + "description": "The activation Mode of the service package", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ], + "x-ms-enum": { + "name": "ServicePackageActivationMode", + "modelAsString": true, + "values": [ + { + "value": "SharedProcess", + "description": "Indicates the application package activation mode will use shared process." + }, + { + "value": "ExclusiveProcess", + "description": "Indicates the application package activation mode will use exclusive process." + } + ] + } + }, + "serviceDnsName": { + "type": "string", + "description": "Dns name used for the service. If this is specified, then the DNS name can be used to return the IP addresses of service endpoints for application layer protocols (e.g., HTTP).\nWhen updating serviceDnsName, old name may be temporarily resolvable. However, rely on new name.\nWhen removing serviceDnsName, removed name may temporarily be resolvable. Do not rely on the name being unresolvable.\n" + } + } + }, + "ServiceResourcePropertiesBase": { + "type": "object", + "description": "The common service resource properties.", + "properties": { + "placementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "correlationScheme": { + "$ref": "#/definitions/CorrelationSchemeList" + }, + "serviceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList" + }, + "servicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList" + }, + "defaultMoveCost": { + "$ref": "#/definitions/MoveCost" + }, + "scalingPolicies": { + "$ref": "#/definitions/ScalingPolicyList" + } + } + }, + "ServiceScalingMechanismKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "ScalePartitionInstanceCount", + "AddRemoveIncrementalNamedPartition" + ], + "x-ms-enum": { + "name": "ServiceScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "ScalePartitionInstanceCount", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition. The value is 0." + }, + { + "value": "AddRemoveIncrementalNamedPartition", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. The value is 1." + } + ] + } + }, + "ServiceScalingTriggerKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "AveragePartitionLoadTrigger", + "AverageServiceLoadTrigger" + ], + "x-ms-enum": { + "name": "ServiceScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "AveragePartitionLoadTrigger", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition. The value is 0." + }, + { + "value": "AverageServiceLoadTrigger", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service. The value is 1." + } + ] + } + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "required": [ + "maxPercentUnhealthyServices", + "maxPercentUnhealthyPartitionsPerService", + "maxPercentUnhealthyReplicasPerPartition" + ], + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy services.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy partitions per service.\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy replicas per partition.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas.\n", + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + }, + "ServiceUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Service update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Service update request" + }, + "SingletonPartitionScheme": { + "type": "object", + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "SingletonPartitionScheme" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceProperties": { + "type": "object", + "description": "The properties of a stateful service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "hasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "targetReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "quorumLossWaitDuration": { + "type": "string", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "standByReplicaKeepDuration": { + "type": "string", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "servicePlacementTimeLimit": { + "type": "string", + "description": "The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "StatelessServiceProperties": { + "type": "object", + "description": "The properties of a stateless service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "instanceCount" + ], + "properties": { + "instanceCount": { + "type": "integer", + "format": "int32", + "minimum": -1, + "description": "The instance count." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service." + }, + "minInstancePercentage": { + "type": "integer", + "format": "int32", + "description": "MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service." + } + } + }, + "UniformInt64RangePartitionScheme": { + "type": "object", + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionScheme" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "count", + "lowKey", + "highKey" + ], + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The number of partitions." + }, + "lowKey": { + "type": "integer", + "format": "int64", + "description": "The lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" + }, + "highKey": { + "type": "integer", + "format": "int64", + "description": "The upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" + } + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of user assigned identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "description": "The client id of user assigned identity." + } + } + }, + "UserAssignedIdentityMap": { + "type": "object", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2024-06-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "applicationName": { + "name": "applicationName", + "in": "path", + "description": "The name of the application resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationTypeName": { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type name resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "in": "path", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "version": { + "name": "version", + "in": "path", + "description": "The application type version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedcluster.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedcluster.json new file mode 100644 index 000000000000..96ea46b4ed2d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/managedcluster.json @@ -0,0 +1,2379 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2024-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List cluster by resource group": { + "$ref": "./examples/ManagedClusterListByResourceGroupOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListBySubscription", + "summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed clusters": { + "$ref": "./examples/ManagedClusterListBySubscriptionOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}": { + "get": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a Service Fabric managed cluster resource.", + "description": "Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/ManagedClusterGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed cluster resource.", + "description": "Create or update a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a cluster with minimum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_min.json" + }, + "Put a cluster with maximum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Update", + "summary": "Updates the tags of of a Service Fabric managed cluster resource.", + "description": "Update the tags of of a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The managed cluster resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a managed cluster": { + "$ref": "./examples/ManagedClusterPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a Service Fabric managed cluster resource.", + "description": "Delete a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/ManagedClusterDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/getazresiliencystatus": { + "post": { + "tags": [ + "managedAzResiliencyStatus" + ], + "summary": "Action to get Az Resiliency Status of all the Base resources constituting Service Fabric Managed Clusters.", + "description": "Action to get Az Resiliency Status of all the Base resources constituting Service Fabric Managed Clusters.", + "operationId": "managedAzResiliencyStatus_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Az Resiliency status of Base Resources": { + "$ref": "./examples/managedAzResiliencyStatusGet_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedAzResiliencyStatus" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/getMaintenanceWindowStatus": { + "post": { + "tags": [ + "managedMaintenanceWindowStatus" + ], + "summary": "Action to get Maintenance Window Status of the Service Fabric Managed Clusters.", + "description": "Action to get Maintenance Window Status of the Service Fabric Managed Clusters.", + "operationId": "managedMaintenanceWindowStatus_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Maintenance Window Status": { + "$ref": "./examples/ManagedMaintenanceWindowStatusGet_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedMaintenanceWindowStatus" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applyMaintenanceWindow": { + "post": { + "tags": [ + "managedApplyMaintenanceWindow" + ], + "summary": "Action to Apply Maintenance window on the Service Fabric Managed Clusters, right now. Any pending update will be applied.", + "description": "Action to Apply Maintenance window on the Service Fabric Managed Clusters, right now. Any pending update will be applied.", + "operationId": "managedApplyMaintenanceWindow_Post", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Maintenance Window Status": { + "$ref": "./examples/ManagedApplyMaintenanceWindowPost_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_Get", + "summary": "Gets information about a Service Fabric managed cluster code version available in the specified location.", + "description": "Gets information about an available Service Fabric managed cluster code version.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "./examples/ManagedClusterVersionGet_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_GetByEnvironment", + "summary": "Gets information about a Service Fabric cluster code version available for the specified environment.", + "description": "Gets information about an available Service Fabric cluster code version by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version by environment": { + "$ref": "./examples/ManagedClusterVersionGetByEnvironment_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_List", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified location.", + "description": "Gets all available code versions for Service Fabric cluster resources by location.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions": { + "$ref": "./examples/ManagedClusterVersionList_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_ListByEnvironment", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified environment.", + "description": "Gets all available code versions for Service Fabric cluster resources by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions by environment": { + "$ref": "./examples/ManagedClusterVersionListByEnvironment.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes": { + "get": { + "tags": [ + "managedVMSizes" + ], + "summary": "Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.", + "description": "Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.", + "operationId": "managedUnsupportedVMSizes_List", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List unsupported vm sizes": { + "$ref": "./examples/managedUnsupportedVMSizesList_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedVMSizesResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes/{vmSize}": { + "get": { + "tags": [ + "managedVMSizes" + ], + "summary": "Get unsupported vm size for Service Fabric Managed Clusters.", + "description": "Get unsupported vm size for Service Fabric Managed Clusters.", + "operationId": "managedUnsupportedVMSizes_Get", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/vmSize" + } + ], + "x-ms-examples": { + "Get unsupported vm sizes": { + "$ref": "./examples/managedUnsupportedVMSizesGet_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedVMSize" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperations/{operationId}": { + "get": { + "tags": [ + "LongRunningOperations" + ], + "summary": "Get long running operation status.", + "description": "Get long running operation status.", + "operationId": "OperationStatus_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/operationId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get failed operation status": { + "$ref": "./examples/Long_running_operation_status_failed.json" + }, + "Get succeeded operation result": { + "$ref": "./examples/Long_running_operation_status_succeeded.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperationResults/{operationId}": { + "get": { + "tags": [ + "LongRunningOperations" + ], + "summary": "Get long running operation result.", + "description": "Get long running operation result.", + "operationId": "OperationResults_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/operationId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get operation result": { + "$ref": "./examples/Long_running_operation_result.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request is still running.", + "headers": { + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content. For Delete operation results." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API", + "required": true, + "type": "string" + } + ], + "x-ms-examples": { + "List available operations": { + "$ref": "./examples/Operations_example.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ManagedClusterAddOnFeature": { + "type": "string", + "description": "Available cluster add-on features", + "enum": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "x-ms-enum": { + "name": "ManagedClusterAddOnFeature", + "modelAsString": true, + "values": [ + { + "value": "DnsService", + "description": "Dns service" + }, + { + "value": "BackupRestoreService", + "description": "Backup and restore service" + }, + { + "value": "ResourceMonitorService", + "description": "Resource monitor service" + } + ] + } + }, + "ApplicationTypeVersionsCleanupPolicy": { + "type": "object", + "required": [ + "maxUnusedVersionsToKeep" + ], + "properties": { + "maxUnusedVersionsToKeep": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Number of unused versions per application type to keep." + } + }, + "description": "The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3." + }, + "AutoGeneratedDomainNameLabelScope": { + "type": "string", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "AutoGeneratedDomainNameLabelScope", + "modelAsString": true, + "values": [ + { + "value": "TenantReuse", + "description": "TenantReuse allows for the same hash to be created if the resource is created in the same Tenant with the same resource name." + }, + { + "value": "SubscriptionReuse", + "description": "SubscriptionReuse allows for the same hash to be created if the resource is created in the same Subscription with the same resource name." + }, + { + "value": "ResourceGroupReuse", + "description": "ResourceGroupReuse allows for the same hash to be created if the resource is created in the same Resource Group with the same resource name." + }, + { + "value": "NoReuse", + "description": "NoReuse will create a new hash regardless of the Subscription, Resource Group, Tenant and Resource name." + } + ] + }, + "description": "This enum is the entrypoint to using a certificate from a public CA for your cluster. This property was introduced to solve the\ndomain squatting problem with new domains. A domain name will be generated in the following format: ....\nThe hash portion comes from Azure DNS' Deterministic Name Library. The library creates a hash using the cluster's Tenant, Subscription, Resource Group\nand Resource Name using the AutoGeneratedDomainNameLabelScope/reuse policy chosen.\n" + }, + "AzureActiveDirectory": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "ClientCertificate": { + "type": "object", + "required": [ + "isAdmin" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "commonName": { + "type": "string", + "description": "Certificate common name." + }, + "issuerThumbprint": { + "type": "string", + "description": "Issuer thumbprint for the certificate. Only used together with CommonName." + } + }, + "description": "Client certificate definition." + }, + "ClusterHealthPolicy": { + "type": "object", + "required": [ + "maxPercentUnhealthyNodes", + "maxPercentUnhealthyApplications" + ], + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n", + "properties": { + "maxPercentUnhealthyNodes": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyApplications": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ClusterMonitoringPolicy": { + "type": "object", + "description": "Describes the monitoring policies for the cluster upgrade.", + "required": [ + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout" + ], + "properties": { + "healthCheckWaitDuration": { + "type": "string", + "x-ms-format": "duration-constant", + "description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckStableDuration": { + "type": "string", + "x-ms-format": "duration-constant", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + } + } + }, + "ClusterState": { + "type": "string", + "description": "The current state of the cluster.\n", + "enum": [ + "WaitingForNodes", + "Deploying", + "BaselineUpgrade", + "Upgrading", + "UpgradeFailed", + "Ready" + ], + "x-ms-enum": { + "name": "ClusterState", + "modelAsString": true, + "values": [ + { + "value": "WaitingForNodes", + "description": "Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it." + }, + { + "value": "Deploying", + "description": "Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up." + }, + { + "value": "BaselineUpgrade", + "description": "Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time." + }, + { + "value": "Upgrading", + "description": "Indicates that the cluster is being upgraded with the user provided configuration." + }, + { + "value": "UpgradeFailed", + "description": "Indicates that the last upgrade for the cluster has failed." + }, + { + "value": "Ready", + "description": "Indicates that the cluster is in a stable state." + } + ] + } + }, + "ClusterUpgradeCadence": { + "type": "string", + "enum": [ + "Wave0", + "Wave1", + "Wave2" + ], + "x-ms-enum": { + "name": "clusterUpgradeCadence", + "modelAsString": true, + "values": [ + { + "value": "Wave0", + "description": "Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters." + }, + { + "value": "Wave1", + "description": "Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters." + }, + { + "value": "Wave2", + "description": "Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters." + } + ] + }, + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0." + }, + "ClusterUpgradeDeltaHealthPolicy": { + "type": "object", + "description": "Describes the delta health policies for the cluster upgrade.", + "required": [ + "maxPercentDeltaUnhealthyNodes" + ], + "properties": { + "maxPercentDeltaUnhealthyNodes": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentDeltaUnhealthyApplications": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.\nNOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications\n", + "minimum": 0, + "maximum": 100 + } + } + }, + "ClusterUpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n", + "enum": [ + "Automatic", + "Manual" + ], + "default": "Automatic", + "x-ms-enum": { + "name": "ClusterUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available." + }, + { + "value": "Manual", + "description": "The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource." + } + ] + } + }, + "ClusterUpgradePolicy": { + "type": "object", + "properties": { + "forceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "healthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "deltaHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy", + "description": "The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "monitoringPolicy": { + "$ref": "#/definitions/ClusterMonitoringPolicy", + "description": "The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode." + }, + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues.\nWhen this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues.\nThe timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.\nThis value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)\n" + } + }, + "description": "Describes the policy used when upgrading the cluster." + }, + "LoadBalancingRule": { + "type": "object", + "required": [ + "frontendPort", + "backendPort", + "protocol", + "probeProtocol" + ], + "properties": { + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.", + "minimum": 1, + "maximum": 65534 + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "protocol": { + "type": "string", + "description": "The reference to the transport protocol used by the load balancing rule.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + } + }, + "probePort": { + "type": "integer", + "format": "int32", + "description": "The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "probeProtocol": { + "type": "string", + "description": "the reference to the load balancer probe used by the load balancing rule.", + "enum": [ + "tcp", + "http", + "https" + ], + "x-ms-enum": { + "name": "probeProtocol", + "modelAsString": true + } + }, + "probeRequestPath": { + "type": "string", + "description": "The probe request path. Only supported for HTTP/HTTPS probes." + }, + "loadDistribution": { + "type": "string", + "description": "The load distribution policy for this rule." + } + }, + "description": "Describes a load balancing rule." + }, + "LongRunningOperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation.", + "format": "date-time" + }, + "endTime": { + "type": "string", + "description": "The end time of the operation.", + "format": "date-time" + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "The completion percentage of the operation." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The operation error." + } + }, + "description": "Long running operation result." + }, + "ManagedCluster": { + "type": "object", + "required": [ + "sku" + ], + "description": "The managed cluster resource\n", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterProperties", + "description": "The managed cluster resource properties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the managed cluster" + } + } + }, + "ManagedClusterCodeVersionListResult": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + }, + "description": "The list results of the Service Fabric runtime versions." + }, + "ManagedClusterCodeVersionResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identification of the result" + }, + "name": { + "type": "string", + "description": "The name of the result" + }, + "type": { + "type": "string", + "description": "The result resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterVersionDetails" + } + }, + "description": "The result of the Service Fabric runtime versions" + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Managed Cluster list results" + }, + "ManagedClusterProperties": { + "type": "object", + "required": [ + "dnsName", + "adminUserName" + ], + "properties": { + "dnsName": { + "type": "string", + "description": "The cluster dns name." + }, + "fqdn": { + "type": "string", + "description": "The fully qualified domain name associated with the public load balancer of the cluster.", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address associated with the public load balancer of the cluster.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "A service generated unique identifier for the cluster resource.", + "readOnly": true + }, + "clusterState": { + "readOnly": true, + "$ref": "#/definitions/ClusterState", + "description": "The current state of the cluster." + }, + "clusterCertificateThumbprints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of thumbprints of the cluster certificates.", + "readOnly": true + }, + "clientConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for client connections to the cluster.", + "default": 19000 + }, + "httpGatewayConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for HTTP connections to the cluster.", + "default": 19080 + }, + "adminUserName": { + "type": "string", + "description": "VM admin user name." + }, + "adminPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "VM admin user password." + }, + "loadBalancingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "x-ms-identifiers": [], + "description": "Load balancing rules that are applied to the public load balancer of the cluster." + }, + "allowRdpAccess": { + "type": "boolean", + "description": "Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "x-ms-identifiers": [], + "description": "Custom Network Security Rules that are applied to the Virtual Network of the cluster." + }, + "clients": { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificate" + }, + "x-ms-identifiers": [], + "description": "Client certificates that are allowed to manage the cluster." + }, + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The AAD authentication settings of the cluster." + }, + "fabricSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + }, + "x-ms-identifiers": [], + "description": "The list of custom fabric settings to configure the cluster." + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the managed cluster resource." + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "clusterUpgradeMode": { + "$ref": "#/definitions/ClusterUpgradeMode" + }, + "clusterUpgradeCadence": { + "$ref": "#/definitions/ClusterUpgradeCadence", + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'." + }, + "addonFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAddOnFeature" + }, + "description": "List of add-on features to enable on the cluster." + }, + "enableAutoOSUpgrade": { + "type": "boolean", + "description": "Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false." + }, + "zonalResiliency": { + "type": "boolean", + "description": "Indicates if the cluster has zone resiliency.", + "default": false + }, + "applicationTypeVersionsCleanupPolicy": { + "$ref": "#/definitions/ApplicationTypeVersionsCleanupPolicy", + "description": "The policy used to clean up unused versions." + }, + "enableIpv6": { + "type": "boolean", + "description": "Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false." + }, + "subnetId": { + "type": "string", + "description": "If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "x-ms-identifiers": [], + "description": "The list of IP tags associated with the default public IP address of the cluster." + }, + "ipv6Address": { + "type": "string", + "description": "IPv6 address for the cluster if IPv6 is enabled.", + "readOnly": true + }, + "enableServicePublicIP": { + "type": "boolean", + "description": "Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster." + }, + "auxiliarySubnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "x-ms-identifiers": [], + "description": "Auxiliary subnets for the cluster." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpoint" + }, + "x-ms-identifiers": [], + "description": "Service endpoints for subnets in the cluster." + }, + "zonalUpdateMode": { + "$ref": "#/definitions/ZonalUpdateMode", + "description": "Indicates the update mode for Cross Az clusters." + }, + "useCustomVnet": { + "type": "boolean", + "description": "For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types." + }, + "publicIPPrefixId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "description": "Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created." + }, + "publicIPv6PrefixId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "description": "Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created." + }, + "ddosProtectionPlanId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/ddosProtectionPlans" + } + ] + }, + "description": "Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster." + }, + "upgradeDescription": { + "$ref": "#/definitions/ClusterUpgradePolicy", + "description": "The policy to use when upgrading the cluster." + }, + "httpGatewayTokenAuthConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint." + }, + "enableHttpGatewayExclusiveAuthMode": { + "type": "boolean", + "description": "If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined." + }, + "autoGeneratedDomainNameLabelScope": { + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope", + "description": "This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert." + }, + "customFqdn": { + "type": "string", + "description": "If using autoGeneratedDomainNameLabelScope, this is the fully qualified domain name using SFMC's domain, pointing to the public load balancer of the cluster." + } + }, + "description": "Describes the managed cluster resource properties." + }, + "ManagedClusterUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Managed cluster update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Managed cluster update request" + }, + "ManagedClusterVersionDetails": { + "type": "object", + "properties": { + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster." + }, + "supportExpiryUtc": { + "type": "string", + "description": "The date of expiry of support of the version." + }, + "osType": { + "$ref": "#/definitions/OsType" + } + }, + "description": "The detail of the Service Fabric runtime version result" + }, + "ManagedVMSize": { + "type": "object", + "properties": { + "properties": { + "description": "VM Size properties.", + "$ref": "#/definitions/VMSize", + "readOnly": true + }, + "id": { + "type": "string", + "description": "VM Size id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "VM Size name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "VM Size type.", + "readOnly": true + } + }, + "description": "Describes a VM Sizes." + }, + "ManagedVMSizesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Managed VM Sizes for Service Fabric Managed Clusters.", + "items": { + "$ref": "#/definitions/ManagedVMSize" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Managed VM Sizes if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Managed VM Sizes for Service Fabric Managed Clusters." + }, + "ManagedAzResiliencyStatus": { + "type": "object", + "properties": { + "baseResourceStatus": { + "type": "array", + "description": "List of Managed VM Sizes for Service Fabric Managed Clusters.", + "items": { + "$ref": "#/definitions/ResourceAzStatus" + }, + "x-ms-identifiers": [] + }, + "isClusterZoneResilient": { + "type": "boolean", + "description": "URL to get the next set of Managed VM Sizes if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Managed VM Sizes for Service Fabric Managed Clusters." + }, + "ManagedMaintenanceWindowStatus": { + "type": "object", + "properties": { + "isWindowEnabled": { + "type": "boolean", + "description": "If maintenance window is enabled on this cluster.", + "readOnly": true + }, + "isRegionReady": { + "type": "boolean", + "description": "Indicates if the region is ready to configure maintenance windows.", + "readOnly": true + }, + "isWindowActive": { + "type": "boolean", + "description": "If maintenance window is active.", + "readOnly": true + }, + "canApplyUpdates": { + "type": "boolean", + "description": "If updates can be applied.", + "readOnly": true + }, + "lastWindowStatusUpdateAtUTC": { + "type": "string", + "format": "date-time", + "description": "Last window update time in UTC.", + "readOnly": true + }, + "lastWindowStartTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Last window start time in UTC.", + "readOnly": true + }, + "lastWindowEndTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Last window end time in UTC.", + "readOnly": true + } + }, + "description": "Describes the maintenance window status of the Service Fabric Managed Cluster." + }, + "ResourceAzStatus": { + "type": "object", + "properties": { + "resourceName": { + "type": "string", + "description": "VM Size properties.", + "readOnly": true + }, + "resourceType": { + "type": "string", + "description": "VM Size id.", + "readOnly": true + }, + "isZoneResilient": { + "type": "boolean", + "description": "VM Size name.", + "readOnly": true + }, + "details": { + "type": "string", + "description": "Zone resiliency status details for the resource.", + "readOnly": true + } + }, + "description": "Describes Az Resiliency status of Base resources" + }, + "OsType": { + "type": "string", + "description": "Cluster operating system, the default will be Windows", + "enum": [ + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "value": "Windows", + "description": "Indicates os is Windows." + } + ] + } + }, + "ServiceEndpoint": { + "type": "object", + "required": [ + "service" + ], + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + } + }, + "description": "The service endpoint properties." + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Sku Name." + } + }, + "description": "Service Fabric managed cluster Sku definition" + }, + "SkuName": { + "type": "string", + "description": "Sku Name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic requires a minimum of 3 nodes and allows only 1 node type." + }, + { + "value": "Standard", + "description": "Requires a minimum of 5 nodes and allows 1 or more node type." + } + ] + } + }, + "Subnet": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Subnet name." + }, + "enableIpv6": { + "type": "boolean", + "description": "Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster." + }, + "privateEndpointNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private end point in the subnet.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "privateEndpointNetworkPolicies", + "modelAsString": true + } + }, + "privateLinkServiceNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private link service in the subnet.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "privateLinkServiceNetworkPolicies", + "modelAsString": true + } + }, + "networkSecurityGroupId": { + "type": "string", + "description": "Full resource id for the network security group." + } + }, + "description": "Describes a Subnet." + }, + "VMSize": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "VM Size name.", + "readOnly": true + } + }, + "description": "VM Sizes properties." + }, + "ZonalUpdateMode": { + "type": "string", + "description": "Indicates the update mode for Cross Az clusters.", + "enum": [ + "Standard", + "Fast" + ], + "x-ms-enum": { + "name": "ZonalUpdateMode", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "The cluster will use 5 upgrade domains for Cross Az Node types." + }, + { + "value": "Fast", + "description": "The cluster will use a maximum of 3 upgrade domains per zone instead of 5 for Cross Az Node types for faster deployments." + } + ] + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "IpTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "The IP tag associated with the public IP address." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of operations supported by the Service Fabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric resource provider operations." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "Resource": { + "type": "object", + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "description": "Azure resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "etag": { + "type": "string", + "description": "Azure resource etag.", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "SettingsParameterDescription": { + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2024-06-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "The operating system of the cluster. The default means all.", + "required": true, + "type": "string", + "enum": [ + "Windows" + ], + "x-ms-parameter-location": "method", + "x-ms-enum": { + "name": "ManagedClusterVersionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "Windows", + "description": "Windows." + } + ] + } + }, + "locationForClusterCodeVersions": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions. This is different from cluster location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "operationId": { + "name": "operationId", + "in": "path", + "description": "operation identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "vmSize": { + "name": "vmSize", + "in": "path", + "description": "VM Size name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/nodetype.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/nodetype.json new file mode 100644 index 000000000000..2abc6222caea --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2024-06-01-preview/nodetype.json @@ -0,0 +1,2091 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2024-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes": { + "get": { + "operationId": "NodeTypes_ListByManagedClusters", + "summary": "Gets the list of Node types of the specified managed cluster.", + "description": "Gets all Node types of the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "tags": [ + "NodeType" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List node type of the specified managed cluster": { + "$ref": "./examples/NodeTypeListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Restart", + "summary": "Restarts one or more nodes on the node type.", + "description": "Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for restart action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Restart nodes": { + "$ref": "./examples/RestartNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Reimage", + "summary": "Reimages one or more nodes on the node type.", + "description": "Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for reimage action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Reimage nodes": { + "$ref": "./examples/ReimageNodes_example.json" + }, + "Reimage all nodes By upgrade domain": { + "$ref": "./examples/ReimageNodes_UD_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_DeleteNode", + "summary": "Deletes one or more nodes on the node type.", + "description": "Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for delete action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Delete nodes": { + "$ref": "./examples/DeleteNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypeSkus_List", + "summary": "Gets a Service Fabric node type SKUs.", + "description": "Get a Service Fabric node type supported SKUs.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List a node type SKUs": { + "$ref": "./examples/NodeTypeSkusListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListSkuResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Get", + "summary": "Gets a Service Fabric node type.", + "description": "Get a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a node type": { + "$ref": "./examples/NodeTypeGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric node type.", + "description": "Create or update a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The node type resource.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeType" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a node type with minimum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_min.json" + }, + "Put a node type with maximum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_max.json" + }, + "Put a node type with auto-scale parameters": { + "$ref": "./examples/NodeTypePutOperationAutoScale_example.json" + }, + "Put an stateless node type with temporary disk for service fabric": { + "$ref": "./examples/NodeTypePutOperationStateless_example.json" + }, + "Put node type with dedicated hosts": { + "$ref": "./examples/NodeTypePutOperationDedicatedHost_example.json" + }, + "Put node type with custom vm image": { + "$ref": "./examples/NodeTypePutOperationCustomImage_example.json" + }, + "Put node type with shared galleries custom vm image": { + "$ref": "./examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json" + }, + "Put node type with vm image plan ": { + "$ref": "./examples/NodeTypePutOperationVmImagePlan_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NodeType" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Update", + "summary": "Update the tags of a node type resource of a given managed cluster.", + "description": "Update the configuration of a node type of a given managed cluster, only updating tags.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters to update the node type configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a node type": { + "$ref": "./examples/NodeTypePatchOperation_example.json" + }, + "Patch a node type while auto-scaling": { + "$ref": "./examples/NodeTypePatchOperationAutoScale_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Delete", + "summary": "Deletes a Service Fabric node type.", + "description": "Delete a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a node type": { + "$ref": "./examples/NodeTypeDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL to get the status of an ongoing long-running operation.", + "type": "string" + }, + "Location": { + "description": "The URL to get the status of a completed long-running operation.", + "type": "string" + } + } + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "AdditionalNetworkInterfaceConfiguration": { + "type": "object", + "required": [ + "name", + "ipConfigurations" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "dscpConfiguration": { + "$ref": "#/definitions/SubResource", + "description": "Specifies the DSCP configuration to apply to the network interface." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/IpConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the IP configurations of the network interface." + } + }, + "description": "Specifies the settings for a network interface to attach to the node type." + }, + "DiskType": { + "type": "string", + "description": "Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types.\n", + "enum": [ + "Standard_LRS", + "StandardSSD_LRS", + "Premium_LRS" + ], + "default": "StandardSSD_LRS", + "x-ms-enum": { + "name": "DiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + } + ] + } + }, + "EvictionPolicyType": { + "type": "string", + "description": "Specifies the eviction policy for virtual machines in a SPOT node type.", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "EvictionPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Eviction policy will be Delete for SPOT vms." + }, + { + "value": "Deallocate", + "description": "Eviction policy will be Deallocate for SPOT vms." + } + ] + } + }, + "FrontendConfiguration": { + "type": "object", + "properties": { + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "The IP address type of this frontend configuration. If omitted the default value is IPv4." + }, + "loadBalancerBackendAddressPoolId": { + "type": "string", + "format": "arm-id", + "description": "The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'." + }, + "loadBalancerInboundNatPoolId": { + "type": "string", + "format": "arm-id", + "description": "The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'." + }, + "applicationGatewayBackendAddressPoolId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationGateways/backendAddressPools" + } + ] + }, + "description": "The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGateways//backendAddressPools/'." + } + }, + "description": "Describes the frontend configurations for the node type." + }, + "IPAddressType": { + "type": "string", + "description": "The IP address type.\n", + "enum": [ + "IPv4", + "IPv6" + ], + "default": "IPv4", + "x-ms-enum": { + "name": "IPAddressType", + "modelAsString": true, + "values": [ + { + "value": "IPv4", + "description": "IPv4 address type." + }, + { + "value": "IPv6", + "description": "IPv6 address type." + } + ] + } + }, + "IpConfiguration": { + "type": "object", + "required": [ + "name" + ], + "description": "Specifies an IP configuration of the network interface.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network interface." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer.\t" + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer." + }, + "subnet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies the subnet of the network interface." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4.", + "enum": [ + "IPv4", + "IPv6" + ], + "default": "IPv4", + "x-ms-enum": { + "name": "privateIPAddressVersion", + "modelAsString": true, + "values": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + } + }, + "publicIPAddressConfiguration": { + "type": "object", + "required": [ + "name" + ], + "description": "The public IP address configuration of the network interface.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network interface." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "x-ms-identifiers": [], + "description": "Specifies the list of IP tags associated with the public IP address." + }, + "publicIPAddressVersion": { + "type": "string", + "description": "Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4.", + "enum": [ + "IPv4", + "IPv6" + ], + "default": "IPv4", + "x-ms-enum": { + "name": "publicIPAddressVersion", + "modelAsString": true, + "values": [ + { + "value": "IPv4" + }, + { + "value": "IPv6" + } + ] + } + } + } + } + } + }, + "ManagedProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "NodeType": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NodeTypeProperties", + "description": "The node type properties" + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeActionParameters": { + "type": "object", + "properties": { + "nodes": { + "description": "List of node names from the node type.", + "type": "array", + "items": { + "type": "string" + } + }, + "force": { + "description": "Force the action to go through.", + "type": "boolean" + }, + "updateType": { + "type": "string", + "description": "Specifies the way the operation will be performed.", + "enum": [ + "Default", + "ByUpgradeDomain" + ], + "x-ms-enum": { + "name": "updateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "The operation will proceed in all specified nodes at the same time." + }, + { + "value": "ByUpgradeDomain", + "description": "The operation will proceed one upgrade domain at a time, checking the health in between each to continue." + } + ] + } + } + }, + "description": "Parameters for Node type action. If nodes are not specified on the parameters, the operation will be performed in all nodes of the node type one upgrade domain at a time." + }, + "NodeTypeProperties": { + "type": "object", + "required": [ + "isPrimary", + "vmInstanceCount" + ], + "properties": { + "isPrimary": { + "type": "boolean", + "description": "Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created." + }, + "vmInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale.", + "minimum": -1, + "maximum": 2147483647 + }, + "dataDiskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Disk size for the managed disk attached to the vms on the node type in GBs." + }, + "dataDiskType": { + "$ref": "#/definitions/DiskType", + "description": "Managed data disk type. Specifies the storage account type for the managed disk" + }, + "dataDiskLetter": { + "type": "string", + "pattern": "^[a-zA-Z]{1}$", + "description": "Managed data disk letter. It can not use the reserved letter C or D and it can not change after created." + }, + "placementProperties": { + "type": "object", + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", + "additionalProperties": { + "type": "string", + "description": "Placement tag value" + } + }, + "capacities": { + "type": "object", + "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", + "additionalProperties": { + "type": "string", + "description": "Capacity tag value" + } + }, + "applicationPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ports from which cluster assigned port to Service Fabric applications." + }, + "ephemeralPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ephemeral ports that nodes in this node type should be configured with." + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3." + }, + "vmImagePublisher": { + "type": "string", + "description": "The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer." + }, + "vmImageOffer": { + "type": "string", + "description": "The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer." + }, + "vmImageSku": { + "type": "string", + "description": "The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter." + }, + "vmImageVersion": { + "type": "string", + "description": "The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "vmSecrets": { + "type": "array", + "title": "virtual machine secretes.", + "description": "The secrets to install in the virtual machines.", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault" + ] + }, + "vmExtensions": { + "type": "array", + "title": "virtual machine extensions.", + "description": "Set of extensions that should be installed onto the virtual machines.", + "items": { + "$ref": "#/definitions/VMSSExtension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "vmManagedIdentity": { + "$ref": "#/definitions/VmManagedIdentity", + "description": "Identities to assign to the virtual machine scale set under the node type." + }, + "isStateless": { + "type": "boolean", + "description": "Indicates if the node type can only host Stateless workloads.", + "default": false + }, + "multiplePlacementGroups": { + "type": "boolean", + "description": "Indicates if scale set associated with the node type can be composed of multiple placement groups.", + "default": false + }, + "frontendConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendConfiguration" + }, + "x-ms-identifiers": [], + "description": "Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "x-ms-identifiers": [], + "description": "The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations." + }, + "additionalDataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VmssDataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Additional managed data disks." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "description": "Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.", + "default": false + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the node type resource." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "useDefaultPublicLoadBalancer": { + "type": "boolean", + "description": "Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity." + }, + "useTempDataDisk": { + "type": "boolean", + "description": "Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types." + }, + "enableOverProvisioning": { + "type": "boolean", + "description": "Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the availability zones where the node type would span across. If the cluster is not spanning across availability zones, initiates az migration for the cluster." + }, + "isSpotVM": { + "type": "boolean", + "description": "Indicates whether the node type will be Spot Virtual Machines. Azure will allocate the VMs if there is capacity available and the VMs can be evicted at any time." + }, + "hostGroupId": { + "type": "string", + "description": "Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts." + }, + "useEphemeralOSDisk": { + "type": "boolean", + "description": "Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature." + }, + "spotRestoreTimeout": { + "type": "string", + "description": "Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601." + }, + "evictionPolicy": { + "$ref": "#/definitions/EvictionPolicyType", + "description": "Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete." + }, + "vmImageResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/images" + }, + { + "type": "Microsoft.Compute/galleries/images" + }, + { + "type": "Microsoft.Compute/galleries/images/versions" + } + ] + }, + "description": "Indicates the resource id of the vm image. This parameter is used for custom vm image." + }, + "subnetId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "Indicates the resource id of the subnet for the node type." + }, + "vmSetupActions": { + "type": "array", + "items": { + "$ref": "#/definitions/VmSetupAction" + }, + "description": "Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime." + }, + "securityType": { + "type": "string", + "description": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported", + "enum": [ + "TrustedLaunch", + "Standard" + ], + "x-ms-enum": { + "name": "securityType", + "modelAsString": true, + "values": [ + { + "value": "TrustedLaunch", + "description": "Trusted Launch is a security type that secures generation 2 virtual machines." + }, + { + "value": "Standard", + "description": "Standard is the default security type for all machines." + } + ] + } + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType" + }, + "enableNodePublicIP": { + "type": "boolean", + "description": "Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers." + }, + "enableNodePublicIPv6": { + "type": "boolean", + "description": "Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers." + }, + "vmSharedGalleryImageId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/sharedGalleries/images" + }, + { + "type": "Microsoft.Compute/sharedGalleries/images/versions" + } + ] + }, + "description": "Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image." + }, + "natGatewayId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/natGateways" + } + ] + }, + "description": "Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer." + }, + "natConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeNatConfig" + }, + "x-ms-identifiers": [], + "description": "Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer." + }, + "vmImagePlan": { + "$ref": "#/definitions/VmImagePlan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save." + }, + "serviceArtifactReferenceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/galleries/serviceArtifacts/vmArtifactsProfiles" + } + ] + }, + "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version." + }, + "dscpConfigurationId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dscpConfigurations" + } + ] + }, + "description": "Specifies the resource id of the DSCP configuration to apply to the node type network interface." + }, + "additionalNetworkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalNetworkInterfaceConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the settings for any additional secondary network interfaces to attach to the node type." + }, + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name." + }, + "vmApplications": { + "type": "array", + "items": { + "$ref": "#/definitions/VmApplication" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the gallery applications that should be made available to the underlying VMSS." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "node type list value.", + "description": "The list of node types.", + "items": { + "$ref": "#/definitions/NodeType" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type list results" + }, + "NodeTypeNatConfig": { + "type": "object", + "properties": { + "backendPort": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The internal port for the NAT configuration." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65534, + "description": "The port range start for the external endpoint." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65534, + "description": "The port range end for the external endpoint." + } + }, + "description": "Provides information about NAT configuration on the default public Load Balancer for the node type." + }, + "NodeTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Node type update parameters", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + } + }, + "description": "Node type update request" + }, + "NodeTypeSku": { + "type": "object", + "required": [ + "capacity" + ], + "properties": { + "name": { + "type": "string", + "description": "The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

Possible Values:
**Standard**" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount.", + "minimum": 1, + "maximum": 2147483647 + } + }, + "description": "Describes a node type sku." + }, + "NodeTypeSkuCapacity": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Lowest permitted node count in a node type." + }, + "maximum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Highest permitted node count in a node type." + }, + "default": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Default node count in a node type." + }, + "scaleType": { + "$ref": "#/definitions/NodeTypeSkuScaleType", + "readOnly": true, + "description": "Node type capacity scale type." + } + }, + "description": "Provides information about how node type can be scaled." + }, + "NodeTypeSkuScaleType": { + "type": "string", + "description": "Node type capacity scale type.\n", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "default": "None", + "x-ms-enum": { + "name": "NodeTypeSkuScaleType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Node count is not adjustable in any way (e.g. it is fixed)." + }, + { + "value": "Manual", + "description": "The user must manually scale out/in." + }, + { + "value": "Automatic", + "description": "Automatic scale is allowed." + } + ] + } + }, + "NodeTypeAvailableSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The type of resource the sku applies to.

Value: Microsoft.ServiceFabric/managedClusters/nodeTypes." + }, + "sku": { + "$ref": "#/definitions/NodeTypeSupportedSku", + "description": "The supported SKU for a for node type.", + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/NodeTypeSkuCapacity", + "description": "Provides information about how the node count can be scaled.", + "readOnly": true + } + }, + "description": "Defines the type of sku available for a node type" + }, + "NodeTypeSupportedSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The sku name.", + "readOnly": true + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

Possible Values:
**Standard**", + "readOnly": true + } + }, + "description": "Describes a node type supported sku." + }, + "NodeTypeListSkuResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "Node type sku list value.", + "description": "The list of available node type SKUs.", + "items": { + "$ref": "#/definitions/NodeTypeAvailableSku" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type available sku list results" + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier." + } + }, + "description": "Azure resource identifier.", + "x-ms-azure-resource": true + }, + "VaultCertificate": { + "type": "object", + "required": [ + "certificateUrl", + "certificateStore" + ], + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "required": [ + "sourceVault", + "vaultCertificates" + ], + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines." + }, + "VmApplication": { + "type": "object", + "required": [ + "packageReferenceId" + ], + "properties": { + "configurationReference": { + "format": "uri", + "type": "string", + "description": "Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS." + }, + "order": { + "type": "integer", + "format": "int32", + "description": "Optional, Specifies the order in which the packages have to be installed." + }, + "packageReferenceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/galleries/applications/versions" + } + ] + }, + "description": "Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}." + }, + "vmGalleryTags": { + "type": "string", + "description": "Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{\"Tag1\":\"Value1\",\"Tag2\":\"Value2\"}'." + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional, If true, any failure for any operation in the VmApplication will fail the deployment." + } + }, + "description": "Specifies the gallery application that should be made available to the underlying VMSS." + }, + "VmImagePlan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save." + }, + "VmManagedIdentity": { + "type": "object", + "properties": { + "userAssignedIdentities": { + "type": "array", + "description": "The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "items": { + "type": "string" + } + } + }, + "description": "Identities for the virtual machine scale set under the node type." + }, + "VmssDataDisk": { + "type": "object", + "required": [ + "lun", + "diskSizeGB", + "diskType", + "diskLetter" + ], + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Disk size for each vm in the node type in GBs." + }, + "diskType": { + "$ref": "#/definitions/DiskType", + "description": "Managed data disk type. Specifies the storage account type for the managed disk" + }, + "diskLetter": { + "type": "string", + "pattern": "^[a-zA-Z]{1}$", + "description": "Managed data disk letter. It can not use the reserved letter C or D and it can not change after created." + } + }, + "description": "Managed data disk description." + }, + "VmSetupAction": { + "type": "string", + "description": "action to be performed on the vms before bootstrapping the service fabric runtime.", + "enum": [ + "EnableContainers", + "EnableHyperV" + ], + "x-ms-enum": { + "name": "VmSetupAction", + "modelAsString": true, + "values": [ + { + "value": "EnableContainers", + "description": "Enable windows containers feature." + }, + { + "value": "EnableHyperV", + "description": "Enables windows HyperV feature." + } + ] + } + }, + "VMSSExtension": { + "type": "object", + "required": [ + "name", + "properties" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VMSSExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Specifies set of extensions that should be installed onto the virtual machines." + }, + "VMSSExtensionProperties": { + "type": "object", + "required": [ + "publisher", + "type", + "typeHandlerVersion" + ], + "properties": { + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "setupOrder": { + "type": "array", + "items": { + "$ref": "#/definitions/VmssExtensionSetupOrder" + }, + "x-ms-identifiers": [], + "description": "Indicates the setup order for the extension." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VmssExtensionSetupOrder": { + "type": "string", + "description": "Vm extension setup order.\n", + "enum": [ + "BeforeSFRuntime" + ], + "x-ms-enum": { + "name": "VmssExtensionSetupOrder", + "modelAsString": true, + "values": [ + { + "value": "BeforeSFRuntime", + "description": "Indicates that the vm extension should run before the service fabric runtime starts." + } + ] + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "EndpointRangeDescription": { + "type": "object", + "required": [ + "endPort", + "startPort" + ], + "properties": { + "startPort": { + "type": "integer", + "format": "int32", + "description": "Starting port of a range of ports" + }, + "endPort": { + "type": "integer", + "format": "int32", + "description": "End port of a range of ports" + } + }, + "description": "Port range details" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "IpTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "The IP tag associated with the public IP address." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2024-06-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "nodeTypeNameParameter": { + "name": "nodeTypeName", + "in": "path", + "description": "The name of the node type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/readme.md b/specification/servicefabricmanagedclusters/resource-manager/readme.md index d59ad5c39e4b..c0bcf88ae35a 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/readme.md +++ b/specification/servicefabricmanagedclusters/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the ServiceFabricManagedClustersManagementClie title: ServiceFabricManagedClustersManagementClient description: Service Fabric Managed Clusters Management Client openapi-type: arm -tag: package-2024-04 +tag: package-2024-06-preview directive: - suppress: ListInOperationName @@ -69,6 +69,17 @@ directive: ``` +### Tag: package-2024-06-preview + +These settings apply only when `--tag=package-2024-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06-preview' +input-file: +- Microsoft.ServiceFabric/preview/2024-06-01-preview/managedapplication.json +- Microsoft.ServiceFabric/preview/2024-06-01-preview/managedcluster.json +- Microsoft.ServiceFabric/preview/2024-06-01-preview/nodetype.json +``` + ### Tag: package-2024-04 These settings apply only when `--tag=package-2024-04` is specified on the command line. From 9a73f1c2121fc835bf97ccf586df8a0019a130c8 Mon Sep 17 00:00:00 2001 From: Jingshu918 <138486531+Jingshu918@users.noreply.github.com> Date: Mon, 2 Sep 2024 15:27:18 +0800 Subject: [PATCH 28/30] [DataFactory]Support Iceberg Format As Sink (#30357) * [DataFactory]Support Iceberg Format As Sink * fix * fix --- .../2018-06-01/entityTypes/Dataset.json | 30 +++++++++++++++++++ .../2018-06-01/entityTypes/Pipeline.json | 29 ++++++++++++++++++ .../2020-12-01/entityTypes/Dataset.json | 30 +++++++++++++++++++ .../2020-12-01/entityTypes/Pipeline.json | 29 ++++++++++++++++++ 4 files changed, 118 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 71dc94ec3035..d4eaab7301f4 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -992,6 +992,36 @@ "location" ] }, + "IcebergDataset": { + "x-ms-discriminator-value": "Iceberg", + "description": "Iceberg dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Iceberg dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IcebergDatasetTypeProperties" + } + } + }, + "IcebergDatasetTypeProperties": { + "description": "Iceberg dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the iceberg storage. Setting a file name is not allowed for iceberg format." + } + }, + "required": [ + "location" + ] + }, "AzureBlobDataset": { "x-ms-discriminator-value": "AzureBlob", "description": "The Azure Blob storage.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 3a38134eb663..4c8943de660a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -1597,6 +1597,16 @@ "modelAsString": true } }, + "IcebergWriteSettings": { + "description": "Iceberg write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": {} + }, "AvroSource": { "description": "A copy activity Avro source.", "type": "object", @@ -4766,6 +4776,25 @@ } } }, + "IcebergSink": { + "description": "A copy activity Iceberg sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Iceberg store settings." + }, + "formatSettings": { + "$ref": "#/definitions/IcebergWriteSettings", + "description": "Iceberg format settings." + } + } + }, "BlobSink": { "description": "A copy activity Azure Blob sink.", "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json index 2f5a2e9ae593..0b102aecabbc 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -903,6 +903,36 @@ "location" ] }, + "IcebergDataset": { + "x-ms-discriminator-value": "Iceberg", + "description": "Iceberg dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Iceberg dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IcebergDatasetTypeProperties" + } + } + }, + "IcebergDatasetTypeProperties": { + "description": "Iceberg dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the iceberg storage. Setting a file name is not allowed for iceberg format." + } + }, + "required": [ + "location" + ] + }, "AzureBlobDataset": { "x-ms-discriminator-value": "AzureBlob", "description": "The Azure Blob storage.", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 30a74e709cf1..6f61e4e33bac 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -1292,6 +1292,16 @@ "modelAsString": true } }, + "IcebergWriteSettings": { + "description": "Iceberg write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": {} + }, "AvroSource": { "description": "A copy activity Avro source.", "type": "object", @@ -4266,6 +4276,25 @@ } } }, + "IcebergSink": { + "description": "A copy activity Iceberg sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Iceberg store settings." + }, + "formatSettings": { + "$ref": "#/definitions/IcebergWriteSettings", + "description": "Iceberg format settings." + } + } + }, "BlobSink": { "description": "A copy activity Azure Blob sink.", "type": "object", From 28c5000054bf2e8112b5543025a519fa60902503 Mon Sep 17 00:00:00 2001 From: Badea Marjieh <127952241+badeamarjieh@users.noreply.github.com> Date: Mon, 2 Sep 2024 12:38:39 +0300 Subject: [PATCH 29/30] Fix TypeSpec Only (#30400) * . * . --- .../Microsoft.Fabric.Management/capacity.tsp | 26 ++++++++++--------- .../stable/2023-11-01/fabric.json | 12 ++------- 2 files changed, 16 insertions(+), 22 deletions(-) diff --git a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp index 94c6fad070ee..bb2cb0bc77b9 100644 --- a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp +++ b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp @@ -45,10 +45,22 @@ interface FabricCapacities { listBySubscription is ArmListBySubscription; @doc("Resume operation of the specified Fabric capacity instance.") - resume is ArmResourceActionAsync; + resume is ArmResourceActionAsync< + FabricCapacity, + void, + OkResponse, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmLroLocationHeader + >; @doc("Suspend operation of the specified Fabric capacity instance.") - suspend is ArmResourceActionAsync; + suspend is ArmResourceActionAsync< + FabricCapacity, + void, + OkResponse, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader & + ArmLroLocationHeader + >; checkNameAvailability is checkLocalNameAvailability; @@ -74,13 +86,3 @@ interface FabricCapacities { ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, ): RpSkuEnumerationForNewResourceResult | ErrorResponse; } - -@doc("The capacity was successfully suspended") -model SuspendOkStatusCode { - ...OkResponse; -} - -@doc("The capacity was successfully resumed") -model ResumeOkStatusCode { - ...OkResponse; -} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json index 1018facc7be8..e58eddf17373 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json @@ -543,7 +543,7 @@ ], "responses": { "200": { - "description": "The capacity was successfully resumed" + "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", @@ -652,7 +652,7 @@ ], "responses": { "200": { - "description": "The capacity was successfully suspended" + "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", @@ -941,10 +941,6 @@ ] } }, - "ResumeOkStatusCode": { - "type": "object", - "description": "The capacity was successfully resumed" - }, "RpSku": { "type": "object", "description": "Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.", @@ -1087,10 +1083,6 @@ } ] } - }, - "SuspendOkStatusCode": { - "type": "object", - "description": "The capacity was successfully suspended" } }, "parameters": { From eea7584434f9225cad0327d83d5c6d84257a4d7d Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Tue, 3 Sep 2024 15:04:52 +0800 Subject: [PATCH 30/30] Update tspconfig.yaml (#30406) --- specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml index 012442ac90ba..801690bf6bfd 100644 --- a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml +++ b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml @@ -24,7 +24,7 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-directory: "{project-root}/examples" + examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager"