openapi-directory/api/azure.com/network-ipGroups.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-11-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-11-01/ipGroups.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-ipGroups","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/ipGroups":{"get":{"description":"Gets all IpGroups in a subscription.","operationId":"IpGroups_List","parameters":[{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List_IpGroups":{"value":"2019-11-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_IpGroups":{"value":"subId"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of ipGroups resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpGroupListResult"},"examples":{"List_IpGroups":{"$ref":"#/components/examples/List_IpGroups"}}}}},"default":{"description":"Unexpected error.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["IpGroups"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups":{"get":{"description":"Gets all IpGroups in a resource group.","operationId":"IpGroups_ListByResourceGroup","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"ListByResourceGroup_IpGroups":{"value":"myResourceGroup"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ListByResourceGroup_IpGroups":{"value":"2019-11-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":{"ListByResourceGroup_IpGroups":{"value":"subId"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of ipGroups resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpGroupListResult"},"examples":{"ListByResourceGroup_IpGroups":{"$ref":"#/components/examples/ListByResourceGroup_IpGroups"}}}}},"default":{"description":"Unexpected error.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["IpGroups"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}":{"delete":{"description":"Deletes the specified ipGroups.","operationId":"IpGroups_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete_IpGroups":{"value":"myResourceGroup"}}},{"description":"The name of the ipGroups.","in":"path","name":"ipGroupsName","required":true,"schema":{"type":"string"},"examples":{"Delete_IpGroups":{"value":"ipGroups1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete_IpGroups":{"value":"2019-11-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_IpGroups":{"value":"subId"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Delete successful."},"default":{"description":"Unexpected error.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["IpGroups"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified ipGroups.","operationId":"IpGroups_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get_IpGroups":{"value":"myResourceGroup"}}},{"description":"The name of the ipGroups.","in":"path","name":"ipGroupsName","required":true,"schema":{"type":"string"},"examples":{"Get_IpGroups":{"value":"ipGroups1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get_IpGroups":{"value":"2019-11-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_IpGroups":{"value":"subId"}}},{"description":"Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful. The operation returns the resulting IpGroups resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpGroup"},"examples":{"Get_IpGroups":{"$ref":"#/components/examples/Get_IpGroups"}}}}},"default":{"description":"Unexpected error.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["IpGroups"]},"patch":{"description":"Updates tags of an IpGroups resource.","operationId":"IpGroups_UpdateGroups","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Update_IpGroups":{"value":"myResourceGroup"}}},{"description":"The name of the ipGroups.","in":"path","name":"ipGroupsName","required":true,"schema":{"type":"string"},"examples":{"Update_IpGroups":{"value":"ipGroups1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update_IpGroups":{"value":"2019-11-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_IpGroups":{"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 the update ipGroups operation.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the resulting ipGroups resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpGroup"},"examples":{"Update_IpGroups":{"$ref":"#/components/examples/Update_IpGroups"}}}}},"default":{"description":"Unexpected error.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["IpGroups"]},"put":{"description":"Creates or updates an ipGroups in a specified resource group.","operationId":"IpGroups_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"CreateOrUpdate_IpGroups":{"value":"myResourceGroup"}}},{"description":"The name of the ipGroups.","in":"path","name":"ipGroupsName","required":true,"schema":{"type":"string"},"examples":{"CreateOrUpdate_IpGroups":{"value":"ipGroups1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"CreateOrUpdate_IpGroups":{"value":"2019-11-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":{"CreateOrUpdate_IpGroups":{"value":"subId"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpGroup"}}},"description":"Parameters supplied to the create or update IpGroups operation.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the resulting ipGroups resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpGroup"},"examples":{"CreateOrUpdate_IpGroups":{"$ref":"#/components/examples/CreateOrUpdate_IpGroups"}}}}},"201":{"description":"Create successful. The operation returns the resulting ipGroups resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpGroup"},"examples":{"CreateOrUpdate_IpGroups":{"$ref":"#/components/examples/CreateOrUpdate_IpGroups"}}}}},"default":{"description":"Unexpected error.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["IpGroups"],"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_IpGroups":{"value":{"value":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup1/ipGroups","location":"westcentralus","name":"iptag1","properties":{"firewalls":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"}],"ipAddresses":["13.64.39.16/32","40.74.146.80/31","40.74.147.32/28"],"provisioningState":"Succeeded"},"type":"Microsoft.Network/ipGroups"},{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup2/ipGroups","location":"centralus","name":"iptag2","properties":{"firewalls":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"}],"ipAddresses":["14.64.39.16/32","41.74.146.80/31","42.74.147.32/28"],"provisioningState":"Succeeded"},"type":"Microsoft.Network/ipGroups"}]}},"ListByResourceGroup_IpGroups":{"value":{"value":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups","location":"westcentralus","name":"ipGroups1","properties":{"firewalls":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"}],"ipAddresses":["13.64.39.16/32","40.74.146.80/31","40.74.147.32/28"],"provisioningState":"Succeeded"},"type":"Microsoft.Network/ipGroups"},{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups","location":"centralus","name":"ipGroups2","properties":{"firewalls":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"}],"ipAddresses":["14.64.39.16/32","41.74.146.80/31","42.74.147.32/28"],"provisioningState":"Succeeded"},"type":"Microsoft.Network/ipGroups"}]}},"Get_IpGroups":{"value":{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1","location":"westcentralus","name":"ipGroups1","properties":{"firewalls":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"}],"ipAddresses":["13.64.39.16/32","40.74.146.80/31","40.74.147.32/28"],"provisioningState":"Succeeded"},"type":"Microsoft.Network/ipGroups"}},"Update_IpGroups":{"value":{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1","location":"westcentralus","name":"ipGroups1","properties":{"firewalls":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"}],"ipAddresses":["13.64.39.16/32","40.74.146.80/31","40.74.147.32/28"],"provisioningState":"Succeeded"},"tags":{"key1":"value1","key2":"value2"},"type":"Microsoft.Network/ipGroups"}},"CreateOrUpdate_IpGroups":{"value":{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1","location":"westcentralus","name":"ipGroups1","properties":{"firewalls":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"}],"ipAddresses":["13.64.39.16/32","40.74.146.80/31","40.74.147.32/28"],"provisioningState":"Succeeded"},"type":"Microsoft.Network/ipGroups"}}},"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":{"IpGroup":{"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":"The IpGroups resource information.","properties":{"etag":{"description":"A unique read-only string that changes whenever the resource is updated.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/IpGroupPropertiesFormat"}}},"IpGroupListResult":{"description":"Response for the ListIpGroups API service call.","properties":{"nextLink":{"description":"URL to get the next set of results.","type":"string"},"value":{"description":"The list of IpGroups information resources.","items":{"$ref":"#/components/schemas/IpGroup"},"type":"array"}}},"IpGroupPropertiesFormat":{"description":"The IpGroups property information.","properties":{"firewalls":{"description":"List of references to Azure resources that this IpGroups is associated with.","items":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"readOnly":true,"type":"array"},"ipAddresses":{"description":"IpAddresses/IpAddressPrefixes in the IpGroups resource.","items":{"type":"string"},"type":"array"},"provisioningState":{"description":"The current provisioning state.","enum":["Succeeded","Updating","Deleting","Failed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}}}}}}}