swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector LoadBalancers API schemes: - https tags: - name: LoadBalancers paths: /{resourceUri}/providers/Microsoft.KubernetesRuntime/loadBalancers: get: operationId: microsoftAzureLoadbalancersList tags: - LoadBalancers description: List LoadBalancer resources by parent parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/LoadBalancerListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: LoadBalancers_List: $ref: ./examples/LoadBalancers_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Resourceuri Providers Microsoft Kubernetesruntime Loadbalancers /{resourceUri}/providers/Microsoft.KubernetesRuntime/loadBalancers/{loadBalancerName}: get: operationId: microsoftAzureLoadbalancersGet tags: - LoadBalancers description: Get a LoadBalancer parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' - name: loadBalancerName in: path description: The name of the LoadBalancer required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/LoadBalancer' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: LoadBalancers_Get: $ref: ./examples/LoadBalancers_Get.json summary: Microsoft Azure Get Resourceuri Providers Microsoft Kubernetesruntime Loadbalancers Loadbalancername put: operationId: microsoftAzureLoadbalancersCreateorupdate tags: - LoadBalancers description: Create a LoadBalancer parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' - name: loadBalancerName in: path description: The name of the LoadBalancer required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/LoadBalancer' responses: '200': description: Resource 'LoadBalancer' update operation succeeded schema: $ref: '#/definitions/LoadBalancer' '201': description: Resource 'LoadBalancer' create operation succeeded schema: $ref: '#/definitions/LoadBalancer' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: LoadBalancers_CreateOrUpdate: $ref: ./examples/LoadBalancers_CreateOrUpdate.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Microsoft Azure Put Resourceuri Providers Microsoft Kubernetesruntime Loadbalancers Loadbalancername delete: operationId: microsoftAzureLoadbalancersDelete tags: - LoadBalancers description: Delete a LoadBalancer parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' - name: loadBalancerName in: path description: The name of the LoadBalancer required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '202': description: Resource deletion accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: LoadBalancers_Delete: $ref: ./examples/LoadBalancers_Delete.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Delete Resourceuri Providers Microsoft Kubernetesruntime Loadbalancers Loadbalancername ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName} : delete: tags: - LoadBalancers operationId: microsoftAzureLoadbalancersDelete description: The delete loadbalancer operation deletes the specified loadbalancer. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: loadBalancerName in: path required: true type: string description: The name of the loadBalancer. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: '' '202': description: '' '204': description: '' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Loadbalancers Loadbalancername get: tags: - LoadBalancers operationId: microsoftAzureLoadbalancersGet description: The Get network interface operation retrieves information about the specified network interface. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: loadBalancerName in: path required: true type: string description: The name of the loadBalancer. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: '' schema: $ref: '#/definitions/LoadBalancer_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Loadbalancers Loadbalancername put: tags: - LoadBalancers operationId: microsoftAzureLoadbalancersCreateorupdate description: The Put LoadBalancer operation creates/updates a LoadBalancer parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: loadBalancerName in: path required: true type: string description: The name of the loadBalancer. - name: parameters in: body required: true schema: $ref: '#/definitions/LoadBalancer_2' description: Parameters supplied to the create/delete LoadBalancer operation - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: '' schema: $ref: '#/definitions/LoadBalancer_2' '201': description: '' schema: $ref: '#/definitions/LoadBalancer_2' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Loadbalancers Loadbalancername /subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers: get: tags: - LoadBalancers operationId: microsoftAzureLoadbalancersListall description: The List loadBalancer operation retrieves all the load balancers in a subscription. parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: '' schema: $ref: '#/definitions/LoadBalancerListResult_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Loadbalancers /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers: get: tags: - LoadBalancers operationId: microsoftAzureLoadbalancersList description: The List loadBalancer operation retrieves all the load balancers in a resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: '' schema: $ref: '#/definitions/LoadBalancerListResult_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Loadbalancers definitions: FrontendIpConfiguration: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/FrontendIpConfigurationPropertiesFormat' name: type: string description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource etag: type: string description: A unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/SubResource' description: Frontend IP address of the load balancer BackendAddressPoolPropertiesFormat: properties: backendIPConfigurations: type: array items: $ref: '#/definitions/SubResource' description: Gets collection of references to IPs defined in NICs loadBalancingRules: type: array items: $ref: '#/definitions/SubResource' description: Gets Load Balancing rules that use this Backend Address Pool outboundNatRule: $ref: '#/definitions/SubResource' description: Gets outbound rules that use this Backend Address Pool provisioningState: type: string description: Provisioning state of the PublicIP resource Updating/Deleting/Failed description: Properties of BackendAddressPool LoadBalancerListResult_2: properties: value: type: array items: $ref: '#/definitions/LoadBalancer_2' description: Gets a list of LoadBalancers in a resource group nextLink: type: string description: Gets the URL to get the next set of results. description: Response for ListLoadBalancers Api service call InboundNatRulePropertiesFormat: properties: frontendIPConfiguration: $ref: '#/definitions/SubResource' description: Gets or sets a reference to frontend IP Addresses backendIPConfiguration: $ref: '#/definitions/SubResource' description: Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP protocol: type: string description: Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp enum: - Udp - Tcp x-ms-enum: name: TransportProtocol modelAsString: true frontendPort: type: integer format: int32 description: Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive backendPort: type: integer format: int32 description: Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API idleTimeoutInMinutes: type: integer format: int32 description: Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp enableFloatingIP: type: boolean description: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn availability Group. This setting is required when using the SQL Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint provisioningState: type: string description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed required: - protocol - frontendPort - enableFloatingIP description: Properties of Inbound NAT rule OutboundNatRule: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/OutboundNatRulePropertiesFormat' name: type: string description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource etag: type: string description: A unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/SubResource' description: Outbound NAT pool of the loadbalancer AdvertiseMode: type: string description: Enum of advertise mode enum: - ARP - BGP - Both x-ms-enum: name: AdvertiseMode modelAsString: true values: - name: ARP value: ARP description: ARP advertise mode - name: BGP value: BGP description: BGP advertise mode - name: Both value: Both description: both ARP and BGP advertise mode FrontendIpConfigurationPropertiesFormat: properties: privateIPAddress: type: string description: Gets or sets the IP address of the Load Balancer.This is only specified if a specific private IP address shall be allocated from the subnet specified in subnetRef privateIPAllocationMethod: type: string description: Gets or sets PrivateIP allocation method (Static/Dynamic) enum: - Static - Dynamic x-ms-enum: name: IpAllocationMethod modelAsString: true subnet: $ref: '#/definitions/SubResource' description: 'Gets or sets the reference of the subnet resource.A subnet from where the load balancer gets its private frontend address ' publicIPAddress: $ref: '#/definitions/SubResource' description: Gets or sets the reference of the PublicIP resource inboundNatRules: type: array items: $ref: '#/definitions/SubResource' description: Read only.Inbound rules URIs that use this frontend IP inboundNatPools: type: array items: $ref: '#/definitions/SubResource' description: Read only.Inbound pools URIs that use this frontend IP outboundNatRules: type: array items: $ref: '#/definitions/SubResource' description: Read only.Outbound rules URIs that use this frontend IP loadBalancingRules: type: array items: $ref: '#/definitions/SubResource' description: Gets Load Balancing rules URIs that use this frontend IP provisioningState: type: string description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed description: Properties of Frontend IP Configuration of the load balancer LoadBalancingRulePropertiesFormat: properties: frontendIPConfiguration: $ref: '#/definitions/SubResource' description: Gets or sets a reference to frontend IP Addresses backendAddressPool: $ref: '#/definitions/SubResource' description: Gets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs probe: $ref: '#/definitions/SubResource' description: Gets or sets the reference of the load balancer probe used by the Load Balancing rule. protocol: type: string description: Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp enum: - Udp - Tcp x-ms-enum: name: TransportProtocol modelAsString: true loadDistribution: type: string description: Gets or sets the load distribution policy for this rule enum: - Default - SourceIP - SourceIPProtocol x-ms-enum: name: LoadDistribution modelAsString: true frontendPort: type: integer format: int32 description: Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive backendPort: type: integer format: int32 description: Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API idleTimeoutInMinutes: type: integer format: int32 description: Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp enableFloatingIP: type: boolean description: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn availability Group. This setting is required when using the SQL Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint provisioningState: type: string description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed required: - backendAddressPool - protocol - frontendPort - enableFloatingIP description: Properties of the load balancer Resource: properties: id: readOnly: true type: string description: Resource Id name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type location: type: string description: Resource location tags: type: object additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true OutboundNatRulePropertiesFormat: properties: allocatedOutboundPorts: type: integer format: int32 description: Gets or sets the number of outbound ports to be used for SNAT frontendIPConfigurations: type: array items: $ref: '#/definitions/SubResource' description: Gets or sets Frontend IP addresses of the load balancer backendAddressPool: $ref: '#/definitions/SubResource' description: Gets or sets a reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs provisioningState: type: string description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed required: - allocatedOutboundPorts - backendAddressPool description: Outbound NAT pool of the loadbalancer LoadBalancingRule: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/LoadBalancingRulePropertiesFormat' name: type: string description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource etag: type: string description: A unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/SubResource' description: Rules of the load balancer InboundNatRule: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/InboundNatRulePropertiesFormat' name: type: string description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource etag: type: string description: A unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/SubResource' description: Inbound NAT rule of the loadbalancer ProbePropertiesFormat: properties: loadBalancingRules: type: array items: $ref: '#/definitions/SubResource' description: Gets Load balancer rules that use this probe protocol: type: string description: Gets or sets the protocol of the end point. Possible values are http pr Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If http is specified,a 200 OK response from the specifies URI is required for the probe to be successful enum: - Http - Tcp x-ms-enum: name: ProbeProtocol modelAsString: true port: type: integer format: int32 description: Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive. intervalInSeconds: type: integer format: int32 description: Gets or sets the interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5 numberOfProbes: type: integer format: int32 description: 'Gets or sets the number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure. ' requestPath: type: string description: Gets or sets the URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value provisioningState: type: string description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed required: - protocol - port LoadBalancer_2: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/LoadBalancerPropertiesFormat' etag: type: string description: Gets a unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/Resource' description: LoadBalancer resource LoadBalancer: type: object description: A LoadBalancer resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters) properties: properties: $ref: '#/definitions/LoadBalancerProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource InboundNatPoolPropertiesFormat: properties: frontendIPConfiguration: $ref: '#/definitions/SubResource' description: Gets or sets a reference to frontend IP Addresses protocol: type: string description: Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp enum: - Udp - Tcp x-ms-enum: name: TransportProtocol modelAsString: true frontendPortRangeStart: type: integer format: int32 description: Gets or sets the starting port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive frontendPortRangeEnd: type: integer format: int32 description: Gets or sets the ending port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive backendPort: type: integer format: int32 description: Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API provisioningState: type: string description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed required: - protocol - frontendPortRangeStart - frontendPortRangeEnd - backendPort description: Properties of Inbound NAT pool LoadBalancerListResult: type: object description: The response of a LoadBalancer list operation. properties: value: type: array description: The LoadBalancer items on this page items: $ref: '#/definitions/LoadBalancer' nextLink: type: string format: uri description: The link to the next page of items required: - value SubResource: properties: id: type: string description: Resource Id x-ms-azure-resource: true LoadBalancerPropertiesFormat: properties: frontendIPConfigurations: type: array items: $ref: '#/definitions/FrontendIpConfiguration' description: Gets or sets frontend IP addresses of the load balancer backendAddressPools: type: array items: $ref: '#/definitions/BackendAddressPool' description: Gets or sets Pools of backend IP addresses loadBalancingRules: type: array items: $ref: '#/definitions/LoadBalancingRule' description: Gets or sets load balancing rules probes: type: array items: $ref: '#/definitions/Probe' description: Gets or sets list of Load balancer probes inboundNatRules: type: array items: $ref: '#/definitions/InboundNatRule' description: Gets or sets list of inbound rules inboundNatPools: type: array items: $ref: '#/definitions/InboundNatPool' description: Gets or sets inbound NAT pools outboundNatRules: type: array items: $ref: '#/definitions/OutboundNatRule' description: Gets or sets outbound NAT rules resourceGuid: type: string description: Gets or sets resource guid property of the Load balancer resource provisioningState: type: string description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed description: Properties of Load Balancer InboundNatPool: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/InboundNatPoolPropertiesFormat' name: type: string description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource etag: type: string description: A unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/SubResource' description: Inbound NAT pool of the loadbalancer BackendAddressPool: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/BackendAddressPoolPropertiesFormat' name: type: string description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource etag: type: string description: A unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/SubResource' description: Pool of backend IP addresses Probe: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ProbePropertiesFormat' name: type: string description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource etag: type: string description: A unique read-only string that changes whenever the resource is updated allOf: - $ref: '#/definitions/SubResource' description: Load balancer Probe ProvisioningState: type: string description: The status of the current operation. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: Initial provisioning in progress - name: Updating value: Updating description: Update in progress - name: Deleting value: Deleting description: Deletion in progress - name: Accepted value: Accepted description: Change accepted for processing readOnly: true LoadBalancerProperties: type: object description: Details of the LoadBalancer. properties: addresses: type: array description: IP Range items: type: string serviceSelector: type: object description: 'A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.' additionalProperties: type: string advertiseMode: $ref: '#/definitions/AdvertiseMode' description: Advertise Mode provisioningState: $ref: '#/definitions/ProvisioningState' description: Resource provision state readOnly: true required: - addresses - advertiseMode parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. Azure.ResourceManager.ResourceUriParameter: name: resourceUri in: path description: The fully qualified Azure Resource manager identifier of the resource. required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: true SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'