openapi-directory/api/azure.com/network-natGateway.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/natGateway.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-natGateway","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/natGateways":{"get":{"description":"Gets all the Nat Gateways in a subscription.","operationId":"NatGateways_ListAll","parameters":[{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all nat gateways":{"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 nat gateways":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of NatGateway resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGatewayListResult"},"examples":{"List all nat gateways":{"$ref":"#/components/examples/List_all_nat_gateways"}}}}}},"tags":["NatGateways"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways":{"get":{"description":"Gets all nat gateways in a resource group.","operationId":"NatGateways_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List nat gateways in resource group":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List nat gateways in 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 nat gateways in resource group":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of NatGateway resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGatewayListResult"},"examples":{"List nat gateways in resource group":{"$ref":"#/components/examples/List_nat_gateways_in_resource_group"}}}}}},"tags":["NatGateways"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}":{"delete":{"description":"Deletes the specified nat gateway.","operationId":"NatGateways_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete nat gateway":{"value":"rg1"}}},{"description":"The name of the nat gateway.","in":"path","name":"natGatewayName","required":true,"schema":{"type":"string"},"examples":{"Delete nat gateway":{"value":"test-natGateway"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete nat gateway":{"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 nat gateway":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Request successful. Resource does not exist."}},"tags":["NatGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified nat gateway in a specified resource group.","operationId":"NatGateways_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get nat gateway":{"value":"rg1"}}},{"description":"The name of the nat gateway.","in":"path","name":"natGatewayName","required":true,"schema":{"type":"string"},"examples":{"Get nat gateway":{"value":"test-natGateway"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get nat gateway":{"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 nat gateway":{"value":"subid"}}},{"description":"Expands referenced resources.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful. The operation returns the resulting NatGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGateway"},"examples":{"Get nat gateway":{"$ref":"#/components/examples/Get_nat_gateway"}}}}}},"tags":["NatGateways"]},"patch":{"description":"Updates nat gateway tags.","operationId":"NatGateways_UpdateTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Update nat gateway tags":{"value":"rg1"}}},{"description":"The name of the nat gateway.","in":"path","name":"natGatewayName","required":true,"schema":{"type":"string"},"examples":{"Update nat gateway tags":{"value":"test-natGateway"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update nat gateway tags":{"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":{"Update nat gateway tags":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Tags object for patch operations.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}}}}},"description":"Parameters supplied to update nat gateway tags.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting NatGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGateway"},"examples":{"Update nat gateway tags":{"$ref":"#/components/examples/Update_nat_gateway_tags"}}}}}},"tags":["NatGateways"]},"put":{"description":"Creates or updates a nat gateway.","operationId":"NatGateways_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create nat gateway":{"value":"rg1"}}},{"description":"The name of the nat gateway.","in":"path","name":"natGatewayName","required":true,"schema":{"type":"string"},"examples":{"Create nat gateway":{"value":"test-natgateway"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create nat gateway":{"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 nat gateway":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGateway"}}},"description":"Parameters supplied to the create or update nat gateway operation.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting NatGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGateway"},"examples":{"Create nat gateway":{"$ref":"#/components/examples/Create_nat_gateway"}}}}},"201":{"description":"Create successful. The operation returns the resulting NatGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGateway"},"examples":{"Create nat gateway":{"$ref":"#/components/examples/Create_nat_gateway"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatGateway"},"examples":{"Create nat gateway":{"$ref":"#/components/examples/Create_nat_gateway"}}}}}},"tags":["NatGateways"],"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_nat_gateways":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway","location":"westus","name":"test-natGateway","properties":{"idleTimeoutInMinutes":5,"provisioningState":"Succeeded","publicIpAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"publicIpPrefixes":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"}],"subnets":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"}]},"sku":{"name":"Standard"},"type":"Microsoft.Network/natGateways"},{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGatewayes/test-natGateway2","location":"westus","name":"test-natGateway2","properties":{"idleTimeoutInMinutes":5,"provisioningState":"Succeeded","publicIpAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"publicIpPrefixes":[{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"}],"subnets":[{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"}]},"sku":{"name":"Standard"},"type":"Microsoft.Network/natGateways"}]}},"List_nat_gateways_in_resource_group":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateway/test-natGateway","location":"westus","name":"test-natGateway","properties":{"idleTimeoutInMinutes":5,"provisioningState":"Succeeded","publicIpAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"publicIpPrefixes":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"}],"subnets":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"}]},"sku":{"name":"Standard"},"type":"Microsoft.Network/natGateways"},{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGateway/test-natGateway2","location":"westus","name":"test-natGateway2","properties":{"idleTimeoutInMinutes":5,"provisioningState":"Succeeded","publicIpAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"publicIpPrefixes":[{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"}],"subnets":[{"id":"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"}]},"sku":{"name":"Standard"},"type":"Microsoft.Network/natGateways"}]}},"Get_nat_gateway":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway","location":"westus","name":"test-natGateway","properties":{"idleTimeoutInMinutes":5,"provisioningState":"Succeeded","publicIpAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"publicIpPrefixes":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"}],"subnets":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"}]},"sku":{"name":"Standard"},"type":"Microsoft.Network/natGateways"}},"Update_nat_gateway_tags":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway","location":"westus","name":"test-natGateway","properties":{"idleTimeoutInMinutes":5,"provisioningState":"Succeeded","publicIpAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"publicIpPrefixes":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"}],"subnets":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"}]},"sku":{"name":"Standard"},"tags":{"tag1":"value1","tag2":"value2"},"type":"Microsoft.Network/natGateways"}},"Create_nat_gateway":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway","location":"westus","name":"test-natGateway","properties":{"idleTimeoutInMinutes":5,"provisioningState":"Succeeded","publicIpAddresses":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"}],"publicIpPrefixes":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"}],"subnets":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"}]},"sku":{"name":"Standard"},"type":"Microsoft.Network/natGateways"}}},"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":{"NatGateway":{"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":"Nat Gateway resource.","properties":{"etag":{"description":"A unique read-only string that changes whenever the resource is updated.","type":"string"},"properties":{"$ref":"#/components/schemas/NatGatewayPropertiesFormat"},"sku":{"$ref":"#/components/schemas/NatGatewaySku"},"zones":{"description":"A list of availability zones denoting the zone in which Nat Gateway should be deployed.","items":{"type":"string"},"type":"array"}}},"NatGatewayListResult":{"description":"Response for ListNatGateways API service call.","properties":{"nextLink":{"description":"The URL to get the next set of results.","type":"string"},"value":{"description":"A list of Nat Gateways that exists in a resource group.","items":{"$ref":"#/components/schemas/NatGateway"},"type":"array"}}},"NatGatewayPropertiesFormat":{"description":"Nat Gateway properties.","properties":{"idleTimeoutInMinutes":{"description":"The idle timeout of the nat gateway.","format":"int32","type":"integer"},"provisioningState":{"description":"The current provisioning state.","enum":["Succeeded","Updating","Deleting","Failed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"publicIpAddresses":{"description":"An array of public ip addresses associated with the nat gateway resource.","items":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"type":"array"},"publicIpPrefixes":{"description":"An array of public ip prefixes associated with the nat gateway resource.","items":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"type":"array"},"resourceGuid":{"description":"The resource GUID property of the NAT gateway resource.","type":"string"},"subnets":{"description":"An array of references to the subnets using this nat gateway resource.","items":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"readOnly":true,"type":"array"}}},"NatGatewaySku":{"description":"SKU of nat gateway.","properties":{"name":{"description":"Name of Nat Gateway SKU.","enum":["Standard"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"NatGatewaySkuName"}}}}}}}