consumes: - application/json produces: - application/json schemes: - https swagger: '2.0' info: description: >- The Network Cloud APIs provide management of the on-premises clusters and their resources, such as, racks, bare metal hosts, virtual machines, workload networks and more. title: Microsoft Azure NetworkCloud version: 2023-10-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: 'Microsoft Azure List Resource Provider Operations' operationId: microsoftAzureOperationsList parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK 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 tags: - Providers /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/bareMetalMachines: get: description: Get a list of bare metal machines in the provided subscription. summary: 'Microsoft Azure List Bare Metal Machines In The Subscription' operationId: microsoftAzureBaremetalmachinesListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/cloudServicesNetworks: get: description: Get a list of cloud services networks in the provided subscription. summary: 'Microsoft Azure List Cloud Services Networks In The Subscription' operationId: microsoftAzureCloudservicesnetworksListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusterManagers: get: description: Get a list of cluster managers in the provided subscription. summary: 'Microsoft Azure List Cluster Managers In The Subscription' operationId: microsoftAzureClustermanagersListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusters: get: description: Get a list of clusters in the provided subscription. summary: 'Microsoft Azure List Clusters In The Subscription' operationId: microsoftAzureClustersListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/kubernetesClusters: get: description: Get a list of Kubernetes clusters in the provided subscription. summary: 'Microsoft Azure List Kubernetes Clusters In The Subscription' operationId: microsoftAzureKubernetesclustersListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l2Networks: get: description: Get a list of layer 2 (L2) networks in the provided subscription. summary: 'Microsoft Azure List Layer 2 L2 Networks In The Subscription' operationId: microsoftAzureL2networksListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l3Networks: get: description: Get a list of layer 3 (L3) networks in the provided subscription. summary: 'Microsoft Azure List Layer 3 L3 Networks In The Subscription' operationId: microsoftAzureL3networksListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus: get: description: Get a list of rack SKUs in the provided subscription. summary: 'Microsoft Azure List Rack Skus In The Subscription' operationId: microsoftAzureRackskusListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus/{rackSkuName}: get: description: Get the properties of the provided rack SKU. summary: 'Microsoft Azure Retrieve The Rack Sku' operationId: microsoftAzureRackskusGet 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: OK 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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/racks: get: description: Get a list of racks in the provided subscription. summary: 'Microsoft Azure List Racks In The Subscription' operationId: microsoftAzureRacksListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/storageAppliances: get: description: Get a list of storage appliances in the provided subscription. summary: 'Microsoft Azure List Storage Appliances In The Subscription' operationId: microsoftAzureStorageappliancesListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/trunkedNetworks: get: description: Get a list of trunked networks in the provided subscription. summary: 'Microsoft Azure List Trunked Networks In The Subscription' operationId: microsoftAzureTrunkednetworksListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/virtualMachines: get: description: Get a list of virtual machines in the provided subscription. summary: 'Microsoft Azure List Virtual Machines In The Subscription' operationId: microsoftAzureVirtualmachinesListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/volumes: get: description: Get a list of volumes in the provided subscription. summary: 'Microsoft Azure List Volumes In The Subscription' operationId: microsoftAzureVolumesListbysubscription 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines: get: description: Get a list of bare metal machines in the provided resource group. summary: 'Microsoft Azure List Bare Metal Machines In The Resource Group' operationId: microsoftAzureBaremetalmachinesListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName} : get: description: Get properties of the provided bare metal machine. summary: 'Microsoft Azure Retrieve The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new bare metal machine or update the properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: 'Microsoft Azure Create Or Update The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesCreateorupdate 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: OK schema: $ref: '#/definitions/BareMetalMachine' '201': description: Created 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 tags: - Subscriptions delete: description: >- Delete the provided bare metal machine.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: 'Microsoft Azure Delete The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesUpdate 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: OK schema: $ref: '#/definitions/BareMetalMachine' '202': description: Accepted 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: 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/cordon : post: description: Cordon the provided bare metal machine's Kubernetes node. summary: 'Microsoft Azure Cordon The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesCordon 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/powerOff : post: description: Power off the provided bare metal machine. summary: 'Microsoft Azure Power Off The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesPoweroff 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/reimage : post: description: Reimage the provided bare metal machine. summary: 'Microsoft Azure Reimage The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesReimage 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/replace : post: description: Replace the provided bare metal machine. summary: 'Microsoft Azure Replace Service The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesReplace 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/restart : post: description: Restart the provided bare metal machine. summary: 'Microsoft Azure Restart The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesRestart 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /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: 'Microsoft Azure Run The Command On The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesRuncommand 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /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: 'Microsoft Azure Run Data Extraction For A Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesRundataextracts 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /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: 'Microsoft Azure Run Read Only Commands Against A Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesRunreadcommands 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/start : post: description: Start the provided bare metal machine. summary: 'Microsoft Azure Start The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesStart 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/uncordon : post: description: Uncordon the provided bare metal machine's Kubernetes node. summary: 'Microsoft Azure Uncordon The Bare Metal Machine' operationId: microsoftAzureBaremetalmachinesUncordon 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks: get: description: Get a list of cloud services networks in the provided resource group. summary: 'Microsoft Azure List Cloud Services Networks In The Resource Group' operationId: microsoftAzureCloudservicesnetworksListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName} : get: description: Get properties of the provided cloud services network. summary: 'Microsoft Azure Retrieve The Cloud Services Network' operationId: microsoftAzureCloudservicesnetworksGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new cloud services network or update the properties of the existing cloud services network. summary: 'Microsoft Azure Create Or Update The Cloud Services Network' operationId: microsoftAzureCloudservicesnetworksCreateorupdate 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: OK schema: $ref: '#/definitions/CloudServicesNetwork' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided cloud services network. summary: 'Microsoft Azure Delete The Cloud Services Network' operationId: microsoftAzureCloudservicesnetworksDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Cloud Services Network' operationId: microsoftAzureCloudservicesnetworksUpdate 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: OK schema: $ref: '#/definitions/CloudServicesNetwork' '202': description: Accepted 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: 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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers: get: description: Get a list of cluster managers in the provided resource group. summary: 'Microsoft Azure List Cluster Managers In The Resource Group' operationId: microsoftAzureClustermanagersListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName} : get: description: Get the properties of the provided cluster manager. summary: 'Microsoft Azure Retrieve The Cluster Manager' operationId: microsoftAzureClustermanagersGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new cluster manager or update properties of the cluster manager if it exists. summary: 'Microsoft Azure Create Or Update The Cluster Manager' operationId: microsoftAzureClustermanagersCreateorupdate 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: OK schema: $ref: '#/definitions/ClusterManager' '201': description: Created 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 x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided cluster manager. summary: 'Microsoft Azure Delete The Cluster Manager' operationId: microsoftAzureClustermanagersDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Cluster Manager' operationId: microsoftAzureClustermanagersUpdate 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: OK 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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters: get: description: Get a list of clusters in the provided resource group. summary: 'Microsoft Azure List Clusters In The Resource Group' operationId: microsoftAzureClustersListbyresourcegroup 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}: get: description: Get properties of the provided cluster. summary: 'Microsoft Azure Retrieve The Cluster' operationId: microsoftAzureClustersGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new cluster or update the properties of the cluster if it exists. summary: 'Microsoft Azure Create Or Update The Cluster' operationId: microsoftAzureClustersCreateorupdate 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: OK schema: $ref: '#/definitions/Cluster' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided cluster. summary: 'Microsoft Azure Delete The Cluster' operationId: microsoftAzureClustersDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Cluster' operationId: microsoftAzureClustersUpdate 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: OK schema: $ref: '#/definitions/Cluster' '202': description: Accepted 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: Patch cluster AggregatorOrSingleRackDefinition: $ref: ./examples/Clusters_Patch_AggregatorOrSingleRackDefinition.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 tags: - Subscriptions ? /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: 'Microsoft Azure List Bare Metal Machine Key Sets Of The Cluster' operationId: microsoftAzureBaremetalmachinekeysetsListbycluster 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: OK 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName} : get: description: Get bare metal machine key set of the provided cluster. summary: 'Microsoft Azure Retrieve The Bare Metal Machine Key Set Of The Cluster' operationId: microsoftAzureBaremetalmachinekeysetsGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new bare metal machine key set or update the existing one for the provided cluster. summary: 'Microsoft Azure Create Or Update The Bare Metal Machine Key Set Of The Cluster' operationId: microsoftAzureBaremetalmachinekeysetsCreateorupdate 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: OK schema: $ref: '#/definitions/BareMetalMachineKeySet' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the bare metal machine key set of the provided cluster. summary: 'Microsoft Azure Delete The Bare Metal Machine Key Set Of The Cluster' operationId: microsoftAzureBaremetalmachinekeysetsDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch Bare Metal Machine Key Set Of The Cluster' operationId: microsoftAzureBaremetalmachinekeysetsUpdate 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: OK schema: $ref: '#/definitions/BareMetalMachineKeySet' '202': description: Accepted 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: 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 tags: - Subscriptions ? /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: 'Microsoft Azure List Baseboard Management Controller Key Sets Of The Cluster' operationId: microsoftAzureBmckeysetsListbycluster 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: OK 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName} : get: description: Get baseboard management controller key set of the provided cluster. summary: 'Microsoft Azure Retrieve The Baseboard Management Controller Key Set Of The Cluster' operationId: microsoftAzureBmckeysetsGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new baseboard management controller key set or update the existing one for the provided cluster. summary: >- Microsoft Azure Create Or Update The Baseboard Management Controller Key Set Of The Cluster operationId: microsoftAzureBmckeysetsCreateorupdate 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: OK schema: $ref: '#/definitions/BmcKeySet' '201': description: Created 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 tags: - Subscriptions delete: description: >- Delete the baseboard management controller key set of the provided cluster. summary: 'Microsoft Azure Delete The Baseboard Management Controller Key Set Of The Cluster' operationId: microsoftAzureBmckeysetsDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch Baseboard Management Controller Key Set Of The Cluster' operationId: microsoftAzureBmckeysetsUpdate 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: OK schema: $ref: '#/definitions/BmcKeySet' '202': description: Accepted 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: 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy : post: description: >- Deploy the cluster using the rack configuration provided during creation. summary: 'Microsoft Azure Deploy The Cluster' operationId: microsoftAzureClustersDeploy 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations : get: description: Get a list of metrics configurations for the provided cluster. summary: 'Microsoft Azure List Metrics Configurations Of The Cluster' operationId: microsoftAzureMetricsconfigurationsListbycluster 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: OK 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName} : get: description: Get metrics configuration of the provided cluster. summary: 'Microsoft Azure Retrieve The Metrics Configuration Of The Cluster' operationId: microsoftAzureMetricsconfigurationsGet 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: OK 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 tags: - Subscriptions put: description: >- Create new or update the existing metrics configuration of the provided cluster. summary: 'Microsoft Azure Create Or Update Metrics Configuration Of The Cluster' operationId: microsoftAzureMetricsconfigurationsCreateorupdate 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: OK schema: $ref: '#/definitions/ClusterMetricsConfiguration' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the metrics configuration of the provided cluster. summary: 'Microsoft Azure Delete The Metrics Configuration Of The Cluster' operationId: microsoftAzureMetricsconfigurationsDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch Metrics Configuration Of The Cluster' operationId: microsoftAzureMetricsconfigurationsUpdate 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: OK schema: $ref: '#/definitions/ClusterMetricsConfiguration' '202': description: Accepted 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: 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 tags: - Subscriptions ? /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: 'Microsoft Azure Execute A Runtime Protection Scan On The Cluster' operationId: microsoftAzureClustersScanruntime 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /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: 'Microsoft Azure Update The Cluster Version' operationId: microsoftAzureClustersUpdateversion 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters: get: description: Get a list of Kubernetes clusters in the provided resource group. summary: 'Microsoft Azure List Kubernetes Clusters In The Resource Group' operationId: microsoftAzureKubernetesclustersListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName} : get: description: Get properties of the provided the Kubernetes cluster. summary: 'Microsoft Azure Retrieve The Kubernetes Cluster' operationId: microsoftAzureKubernetesclustersGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new Kubernetes cluster or update the properties of the existing one. summary: 'Microsoft Azure Create Or Update The Kubernetes Cluster' operationId: microsoftAzureKubernetesclustersCreateorupdate 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: OK schema: $ref: '#/definitions/KubernetesCluster' '201': description: Created 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 x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided Kubernetes cluster. summary: 'Microsoft Azure Delete The Kubernetes Cluster' operationId: microsoftAzureKubernetesclustersDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Kubernetes Cluster' operationId: microsoftAzureKubernetesclustersUpdate 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: OK schema: $ref: '#/definitions/KubernetesCluster' '202': description: Accepted 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: 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools : get: description: Get a list of agent pools for the provided Kubernetes cluster. summary: 'Microsoft Azure List Agent Pools Of The Kubernetes Cluster' operationId: microsoftAzureAgentpoolsListbykubernetescluster 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: OK 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName} : get: description: Get properties of the provided Kubernetes cluster agent pool. summary: 'Microsoft Azure Retrieve The Kubernetes Cluster Agent Pool' operationId: microsoftAzureAgentpoolsGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new Kubernetes cluster agent pool or update the properties of the existing one. summary: 'Microsoft Azure Create Or Update The Kubernetes Cluster Agent Pool' operationId: microsoftAzureAgentpoolsCreateorupdate 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: OK schema: $ref: '#/definitions/AgentPool' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided Kubernetes cluster agent pool. summary: 'Microsoft Azure Delete The Kubernetes Cluster Agent Pool' operationId: microsoftAzureAgentpoolsDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Kubernetes Cluster Agent Pool' operationId: microsoftAzureAgentpoolsUpdate 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: OK schema: $ref: '#/definitions/AgentPool' '202': description: Accepted 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: 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/restartNode : post: description: Restart a targeted node of a Kubernetes cluster. summary: 'Microsoft Azure Restart A Targeted Node' operationId: microsoftAzureKubernetesclustersRestartnode 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks: get: description: Get a list of layer 2 (L2) networks in the provided resource group. summary: 'Microsoft Azure List Layer 2 L2 Networks In The Resource Group' operationId: microsoftAzureL2networksListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName} : get: description: Get properties of the provided layer 2 (L2) network. summary: 'Microsoft Azure Retrieve The Layer 2 L2 Network' operationId: microsoftAzureL2networksGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new layer 2 (L2) network or update the properties of the existing network. summary: 'Microsoft Azure Create Or Update The Layer 2 L2 Network' operationId: microsoftAzureL2networksCreateorupdate 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: OK schema: $ref: '#/definitions/L2Network' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided layer 2 (L2) network. summary: 'Microsoft Azure Delete The Layer 2 L2 Network' operationId: microsoftAzureL2networksDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided layer 2 (L2) network. summary: 'Microsoft Azure Patch The Layer 2 L2 Network' operationId: microsoftAzureL2networksUpdate 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: OK 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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks: get: description: Get a list of layer 3 (L3) networks in the provided resource group. summary: 'Microsoft Azure List Layer 3 L3 Networks In The Resource Group' operationId: microsoftAzureL3networksListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName} : get: description: Get properties of the provided layer 3 (L3) network. summary: 'Microsoft Azure Retrieve The Layer 3 L3 Network' operationId: microsoftAzureL3networksGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new layer 3 (L3) network or update the properties of the existing network. summary: 'Microsoft Azure Create Or Update The Layer 3 L3 Network' operationId: microsoftAzureL3networksCreateorupdate 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: OK schema: $ref: '#/definitions/L3Network' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided layer 3 (L3) network. summary: 'Microsoft Azure Delete The Layer 3 L3 Network' operationId: microsoftAzureL3networksDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided layer 3 (L3) network. summary: 'Microsoft Azure Patch The Layer 3 L3 Network' operationId: microsoftAzureL3networksUpdate 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: OK 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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks: get: description: Get a list of racks in the provided resource group. summary: 'Microsoft Azure List Racks In The Resource Group' operationId: microsoftAzureRacksListbyresourcegroup 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}: get: description: Get properties of the provided rack. summary: 'Microsoft Azure Retrieve The Rack' operationId: microsoftAzureRacksGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new rack or update properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: 'Microsoft Azure Create Or Update The Rack' operationId: microsoftAzureRacksCreateorupdate 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: OK schema: $ref: '#/definitions/Rack' '201': description: Created 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 tags: - Subscriptions delete: description: >- Delete the provided rack.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: 'Microsoft Azure Delete The Rack' operationId: microsoftAzureRacksDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Rack' operationId: microsoftAzureRacksUpdate 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: OK schema: $ref: '#/definitions/Rack' '202': description: Accepted 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: 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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances: get: description: Get a list of storage appliances in the provided resource group. summary: 'Microsoft Azure List Storage Appliances In The Resource Group' operationId: microsoftAzureStorageappliancesListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName} : get: description: Get properties of the provided storage appliance. summary: 'Microsoft Azure Retrieve The Storage Appliance' operationId: microsoftAzureStorageappliancesGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new storage appliance or update the properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: 'Microsoft Azure Create Or Update The Storage Appliance' operationId: microsoftAzureStorageappliancesCreateorupdate 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: OK schema: $ref: '#/definitions/StorageAppliance' '201': description: Created 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 tags: - Subscriptions delete: description: >- Delete the provided storage appliance.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: 'Microsoft Azure Delete The Storage Appliance' operationId: microsoftAzureStorageappliancesDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Storage Appliance' operationId: microsoftAzureStorageappliancesUpdate 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: OK schema: $ref: '#/definitions/StorageAppliance' '202': description: Accepted 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: 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/disableRemoteVendorManagement : post: description: Disable remote vendor management of the provided storage appliance. summary: 'Microsoft Azure Turn Off Remote Vendor Management For A Storage Appliance, If Supported' operationId: microsoftAzureStorageappliancesDisableremotevendormanagement 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/enableRemoteVendorManagement : post: description: Enable remote vendor management of the provided storage appliance. summary: 'Microsoft Azure Turn On Remote Vendor Management For A Storage Appliance, If Supported' operationId: microsoftAzureStorageappliancesEnableremotevendormanagement 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks: get: description: Get a list of trunked networks in the provided resource group. summary: 'Microsoft Azure List Trunked Networks In The Resource Group' operationId: microsoftAzureTrunkednetworksListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName} : get: description: Get properties of the provided trunked network. summary: 'Microsoft Azure Retrieve The Trunked Network' operationId: microsoftAzureTrunkednetworksGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new trunked network or update the properties of the existing trunked network. summary: 'Microsoft Azure Create Or Update The Trunked Network' operationId: microsoftAzureTrunkednetworksCreateorupdate 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: OK schema: $ref: '#/definitions/TrunkedNetwork' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided trunked network. summary: 'Microsoft Azure Delete The Trunked Network' operationId: microsoftAzureTrunkednetworksDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided trunked network. summary: 'Microsoft Azure Patch The Trunked Network' operationId: microsoftAzureTrunkednetworksUpdate 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: OK 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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines: get: description: Get a list of virtual machines in the provided resource group. summary: 'Microsoft Azure List Virtual Machines In The Resource Group' operationId: microsoftAzureVirtualmachinesListbyresourcegroup 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/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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName} : get: description: Get properties of the provided virtual machine. summary: 'Microsoft Azure Retrieve The Virtual Machine' operationId: microsoftAzureVirtualmachinesGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new virtual machine or update the properties of the existing virtual machine. summary: 'Microsoft Azure Create Or Update The Virtual Machine' operationId: microsoftAzureVirtualmachinesCreateorupdate 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: OK schema: $ref: '#/definitions/VirtualMachine' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided virtual machine. summary: 'Microsoft Azure Delete The Virtual Machine' operationId: microsoftAzureVirtualmachinesDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Virtual Machine' operationId: microsoftAzureVirtualmachinesUpdate 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: OK schema: $ref: '#/definitions/VirtualMachine' '202': description: Accepted 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: 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles : get: description: Get a list of consoles for the provided virtual machine. summary: 'Microsoft Azure List Consoles Of The Virtual Machine' operationId: microsoftAzureConsolesListbyvirtualmachine 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: OK 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName} : get: description: Get properties of the provided virtual machine console. summary: 'Microsoft Azure Retrieve The Virtual Machine Console' operationId: microsoftAzureConsolesGet 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: OK 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 tags: - Subscriptions put: description: >- Create a new virtual machine console or update the properties of the existing virtual machine console. summary: 'Microsoft Azure Create Or Update The Virtual Machine Console' operationId: microsoftAzureConsolesCreateorupdate 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: OK schema: $ref: '#/definitions/Console' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided virtual machine console. summary: 'Microsoft Azure Delete The Virtual Machine Console' operationId: microsoftAzureConsolesDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions 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: 'Microsoft Azure Patch The Virtual Machine Console' operationId: microsoftAzureConsolesUpdate 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: OK schema: $ref: '#/definitions/Console' '202': description: Accepted 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: 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 tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/powerOff : post: description: Power off the provided virtual machine. summary: 'Microsoft Azure Power Off The Virtual Machine' operationId: microsoftAzureVirtualmachinesPoweroff 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/reimage : post: description: Reimage the provided virtual machine. summary: 'Microsoft Azure Reimage The Virtual Machine' operationId: microsoftAzureVirtualmachinesReimage 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/restart : post: description: Restart the provided virtual machine. summary: 'Microsoft Azure Restart The Virtual Machine' operationId: microsoftAzureVirtualmachinesRestart 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/start : post: description: Start the provided virtual machine. summary: 'Microsoft Azure Start The Virtual Machine' operationId: microsoftAzureVirtualmachinesStart 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: Accepted 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes: get: description: Get a list of volumes in the provided resource group. summary: 'Microsoft Azure List Volumes In The Resource Group' operationId: microsoftAzureVolumesListbyresourcegroup 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/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 tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}: get: description: Get properties of the provided volume. summary: 'Microsoft Azure Retrieve The Volume' operationId: microsoftAzureVolumesGet 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: OK 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 tags: - Subscriptions put: description: Create a new volume or update the properties of the existing one. summary: 'Microsoft Azure Create Or Update The Volume' operationId: microsoftAzureVolumesCreateorupdate 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: OK schema: $ref: '#/definitions/Volume' '201': description: Created 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 tags: - Subscriptions delete: description: Delete the provided volume. summary: 'Microsoft Azure Delete The Volume' operationId: microsoftAzureVolumesDelete 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: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided volume. summary: 'Microsoft Azure Patch The Volume' operationId: microsoftAzureVolumesUpdate 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: OK 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 tags: - Subscriptions 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: 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, the default is 1. type: string default: '1' 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. If 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 that 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 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 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. If 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. If 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. If 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 represented in the status of this resource. All resources associated with this cloud services network will be part of the same layer 2 (L2) isolation domain. At least one service network must be created but may be reused across many virtual 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 default: 'True' 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. 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. 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. type: integer format: int64 availableMemoryGB: description: >- The remaining memory in GB that are available in this cluster for workload use. type: integer format: int64 totalApplianceStorageGB: description: >- The total appliance-based storage in GB supported by this cluster for workload use. 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. type: integer format: int64 totalMemoryGB: description: The total memory supported by this cluster for workload use. type: integer format: int64 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: 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: 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: 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. 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 cluster, 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 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 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 cluster, 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 - 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. Limited 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 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 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 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. 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 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. 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. 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. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update. 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. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update. 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 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 is 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 is 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 in GB. 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 in GB. 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. It 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. Only 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. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, 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. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. type: string x-ms-mutability: - read - create ipv6Address: description: >- The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - 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. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For 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. 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 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 GB 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 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 in gigabytes. Required if the createOption is Ephemeral. 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: - 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 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: >- 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: >- 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 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 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 StorageApplianceSkuProperties: type: object title: >- StorageApplianceSkuProperties represents the properties of the storage appliance SKU. properties: capacityGB: description: The maximum capacity of the storage appliance. 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 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 in GB. 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 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: 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 tags: - name: Providers - name: Subscriptions