openapi-directory/api/azure.com/network-bastionHost.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.","title":"NetworkManagementClient","version":"2019-07-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/bastionHost.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-bastionHost","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts":{"get":{"description":"Lists all Bastion Hosts in a subscription.","operationId":"BastionHosts_List","parameters":[{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Bastion Hosts for a given subscription":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all Bastion Hosts for a given subscription":{"value":"subid"}}}],"responses":{"200":{"description":"Success. The operation returns a list of Bastion Host resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BastionHostListResult"},"examples":{"List all Bastion Hosts for a given subscription":{"$ref":"#/components/examples/List_all_Bastion_Hosts_for_a_given_subscription"}}}}}},"tags":["BastionHosts"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts":{"get":{"description":"Lists all Bastion Hosts in a resource group.","operationId":"BastionHosts_ListByResourceGroup","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List all Bastion Hosts for a given resource group":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Bastion Hosts for a given resource group":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all Bastion Hosts for a given resource group":{"value":"subid"}}}],"responses":{"200":{"description":"Success. The operation returns a list of BastionHost resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BastionHostListResult"},"examples":{"List all Bastion Hosts for a given resource group":{"$ref":"#/components/examples/List_all_Bastion_Hosts_for_a_given_resource_group"}}}}}},"tags":["BastionHosts"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}":{"delete":{"description":"Deletes the specified Bastion Host.","operationId":"BastionHosts_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete Bastion Host":{"value":"rg1"}}},{"description":"The name of the Bastion Host.","in":"path","name":"bastionHostName","required":true,"schema":{"type":"string"},"examples":{"Delete Bastion Host":{"value":"bastionhosttenant"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete Bastion Host":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete Bastion Host":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Request successful. Resource with the specified name does not exist."}},"tags":["BastionHosts"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified Bastion Host.","operationId":"BastionHosts_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get Bastion Host":{"value":"rg1"}}},{"description":"The name of the Bastion Host.","in":"path","name":"bastionHostName","required":true,"schema":{"type":"string"},"examples":{"Get Bastion Host":{"value":"bastionhosttenant'"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Bastion Host":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Bastion Host":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns an BastionHost resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BastionHost"},"examples":{"Get Bastion Host":{"$ref":"#/components/examples/Get_Bastion_Host"}}}}}},"tags":["BastionHosts"]},"put":{"description":"Creates or updates the specified Bastion Host.","operationId":"BastionHosts_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create Bastion Host":{"value":"rg1"}}},{"description":"The name of the Bastion Host.","in":"path","name":"bastionHostName","required":true,"schema":{"type":"string"},"examples":{"Create Bastion Host":{"value":"bastionhosttenant'"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create Bastion Host":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create Bastion Host":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BastionHost"}}},"description":"Parameters supplied to the create or update Bastion Host operation.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting Bastion Host resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BastionHost"},"examples":{"Create Bastion Host":{"$ref":"#/components/examples/Create_Bastion_Host"}}}}},"201":{"description":"Create successful. The operation returns the resulting Bastion Host resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BastionHost"},"examples":{"Create Bastion Host":{"$ref":"#/components/examples/Create_Bastion_Host"}}}}}},"tags":["BastionHosts"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_all_Bastion_Hosts_for_a_given_subscription":{"value":{"value":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'","location":"West US","name":"bastionhost'","properties":{"dnsName":"bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com","ipConfigurations":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration","name":"bastionHostIpConfiguration","properties":{"privateIPAllocationMethod":"Dynamic","provisioningState":"Succeeded","publicIPAddress":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"},"subnet":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"}},"type":"Microsoft.Network/bastionHosts/bastionHostIpConfigurations"}],"provisioningState":"Succeeded"},"type":"Microsoft.Network/bastionHosts"}]}},"List_all_Bastion_Hosts_for_a_given_resource_group":{"value":{"value":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'","location":"West US","name":"bastionhost'","properties":{"dnsName":"bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com","ipConfigurations":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration","name":"bastionHostIpConfiguration","properties":{"privateIPAllocationMethod":"Dynamic","provisioningState":"Succeeded","publicIPAddress":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"},"subnet":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"}},"type":"Microsoft.Network/bastionHosts/bastionHostIpConfigurations"}],"provisioningState":"Succeeded"},"type":"Microsoft.Network/bastionHosts"}]}},"Get_Bastion_Host":{"value":{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'","location":"West US","name":"bastionhost'","properties":{"dnsName":"bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com","ipConfigurations":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration","name":"bastionHostIpConfiguration","properties":{"privateIPAllocationMethod":"Dynamic","provisioningState":"Succeeded","publicIPAddress":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"},"subnet":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"}},"type":"Microsoft.Network/bastionHosts/bastionHostIpConfigurations"}],"provisioningState":"Succeeded"},"tags":{"key1":"value1"},"type":"Microsoft.Network/bastionHosts"}},"Create_Bastion_Host":{"value":{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'","location":"West US","name":"bastionhost'","properties":{"dnsName":"bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com","ipConfigurations":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration","name":"bastionHostIpConfiguration","properties":{"privateIPAllocationMethod":"Dynamic","provisioningState":"Succeeded","publicIPAddress":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"},"subnet":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"}},"type":"Microsoft.Network/bastionHosts/bastionHostIpConfigurations"}],"provisioningState":"Succeeded"},"type":"Microsoft.Network/bastionHosts"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"BastionHost":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Bastion Host resource.","properties":{"etag":{"description":"A unique read-only string that changes whenever the resource is updated.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/BastionHostPropertiesFormat"}}},"BastionHostIPConfiguration":{"allOf":[{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true}],"description":"IP configuration of an Bastion Host.","properties":{"etag":{"description":"A unique read-only string that changes whenever the resource is updated.","readOnly":true,"type":"string"},"name":{"description":"Name of the resource that is unique within a resource group. This name can be used to access the resource.","type":"string"},"properties":{"$ref":"#/components/schemas/BastionHostIPConfigurationPropertiesFormat"},"type":{"description":"Ip configuration type.","readOnly":true,"type":"string"}}},"BastionHostIPConfigurationPropertiesFormat":{"description":"Properties of IP configuration of an Bastion Host.","properties":{"privateIPAllocationMethod":{"description":"IP address allocation method.","enum":["Static","Dynamic"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IPAllocationMethod"}},"provisioningState":{"description":"The current provisioning state.","enum":["Succeeded","Updating","Deleting","Failed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"publicIPAddress":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"subnet":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true}},"required":["subnet","publicIPAddress"]},"BastionHostListResult":{"description":"Response for ListBastionHosts API service call.","properties":{"nextLink":{"description":"URL to get the next set of results.","type":"string"},"value":{"description":"List of Bastion Hosts in a resource group.","items":{"$ref":"#/components/schemas/BastionHost"},"type":"array"}}},"BastionHostPropertiesFormat":{"description":"Properties of the Bastion Host.","properties":{"dnsName":{"description":"FQDN for the endpoint on which bastion host is accessible.","type":"string"},"ipConfigurations":{"description":"IP configuration of the Bastion Host resource.","items":{"$ref":"#/components/schemas/BastionHostIPConfiguration"},"type":"array"},"provisioningState":{"description":"The current provisioning state.","enum":["Succeeded","Updating","Deleting","Failed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}}}}}}}