1package apimanagement 2 3// Copyright (c) Microsoft and contributors. All rights reserved. 4// 5// Licensed under the Apache License, Version 2.0 (the "License"); 6// you may not use this file except in compliance with the License. 7// You may obtain a copy of the License at 8// http://www.apache.org/licenses/LICENSE-2.0 9// 10// Unless required by applicable law or agreed to in writing, software 11// distributed under the License is distributed on an "AS IS" BASIS, 12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13// 14// See the License for the specific language governing permissions and 15// limitations under the License. 16// 17// Code generated by Microsoft (R) AutoRest Code Generator. 18// Changes may cause incorrect behavior and will be lost if the code is regenerated. 19 20import ( 21 "context" 22 "github.com/Azure/go-autorest/autorest" 23 "github.com/Azure/go-autorest/autorest/azure" 24 "github.com/Azure/go-autorest/autorest/validation" 25 "github.com/Azure/go-autorest/tracing" 26 "net/http" 27) 28 29// UserSubscriptionClient is the apiManagement Client 30type UserSubscriptionClient struct { 31 BaseClient 32} 33 34// NewUserSubscriptionClient creates an instance of the UserSubscriptionClient client. 35func NewUserSubscriptionClient(subscriptionID string) UserSubscriptionClient { 36 return NewUserSubscriptionClientWithBaseURI(DefaultBaseURI, subscriptionID) 37} 38 39// NewUserSubscriptionClientWithBaseURI creates an instance of the UserSubscriptionClient client. 40func NewUserSubscriptionClientWithBaseURI(baseURI string, subscriptionID string) UserSubscriptionClient { 41 return UserSubscriptionClient{NewWithBaseURI(baseURI, subscriptionID)} 42} 43 44// List lists the collection of subscriptions of the specified user. 45// Parameters: 46// resourceGroupName - the name of the resource group. 47// serviceName - the name of the API Management service. 48// userID - user identifier. Must be unique in the current API Management service instance. 49// filter - | Field | Usage | Supported operators | Supported functions 50// |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt 51// | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | 52// substringof, contains, startswith, endswith | </br>| stateComment | filter | ge, le, eq, ne, gt, lt | 53// substringof, contains, startswith, endswith | </br>| ownerId | filter | ge, le, eq, ne, gt, lt | 54// substringof, contains, startswith, endswith | </br>| scope | filter | ge, le, eq, ne, gt, lt | substringof, 55// contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, 56// startswith, endswith | </br>| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, 57// startswith, endswith | </br> 58// top - number of records to return. 59// skip - number of records to skip. 60func (client UserSubscriptionClient) List(ctx context.Context, resourceGroupName string, serviceName string, userID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error) { 61 if tracing.IsEnabled() { 62 ctx = tracing.StartSpan(ctx, fqdn+"/UserSubscriptionClient.List") 63 defer func() { 64 sc := -1 65 if result.sc.Response.Response != nil { 66 sc = result.sc.Response.Response.StatusCode 67 } 68 tracing.EndSpan(ctx, sc, err) 69 }() 70 } 71 if err := validation.Validate([]validation.Validation{ 72 {TargetValue: serviceName, 73 Constraints: []validation.Constraint{{Target: "serviceName", Name: validation.MaxLength, Rule: 50, Chain: nil}, 74 {Target: "serviceName", Name: validation.MinLength, Rule: 1, Chain: nil}, 75 {Target: "serviceName", Name: validation.Pattern, Rule: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`, Chain: nil}}}, 76 {TargetValue: userID, 77 Constraints: []validation.Constraint{{Target: "userID", Name: validation.MaxLength, Rule: 80, Chain: nil}, 78 {Target: "userID", Name: validation.MinLength, Rule: 1, Chain: nil}}}, 79 {TargetValue: top, 80 Constraints: []validation.Constraint{{Target: "top", Name: validation.Null, Rule: false, 81 Chain: []validation.Constraint{{Target: "top", Name: validation.InclusiveMinimum, Rule: 1, Chain: nil}}}}}, 82 {TargetValue: skip, 83 Constraints: []validation.Constraint{{Target: "skip", Name: validation.Null, Rule: false, 84 Chain: []validation.Constraint{{Target: "skip", Name: validation.InclusiveMinimum, Rule: 0, Chain: nil}}}}}}); err != nil { 85 return result, validation.NewError("apimanagement.UserSubscriptionClient", "List", err.Error()) 86 } 87 88 result.fn = client.listNextResults 89 req, err := client.ListPreparer(ctx, resourceGroupName, serviceName, userID, filter, top, skip) 90 if err != nil { 91 err = autorest.NewErrorWithError(err, "apimanagement.UserSubscriptionClient", "List", nil, "Failure preparing request") 92 return 93 } 94 95 resp, err := client.ListSender(req) 96 if err != nil { 97 result.sc.Response = autorest.Response{Response: resp} 98 err = autorest.NewErrorWithError(err, "apimanagement.UserSubscriptionClient", "List", resp, "Failure sending request") 99 return 100 } 101 102 result.sc, err = client.ListResponder(resp) 103 if err != nil { 104 err = autorest.NewErrorWithError(err, "apimanagement.UserSubscriptionClient", "List", resp, "Failure responding to request") 105 } 106 107 return 108} 109 110// ListPreparer prepares the List request. 111func (client UserSubscriptionClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, userID string, filter string, top *int32, skip *int32) (*http.Request, error) { 112 pathParameters := map[string]interface{}{ 113 "resourceGroupName": autorest.Encode("path", resourceGroupName), 114 "serviceName": autorest.Encode("path", serviceName), 115 "subscriptionId": autorest.Encode("path", client.SubscriptionID), 116 "userId": autorest.Encode("path", userID), 117 } 118 119 const APIVersion = "2019-01-01" 120 queryParameters := map[string]interface{}{ 121 "api-version": APIVersion, 122 } 123 if len(filter) > 0 { 124 queryParameters["$filter"] = autorest.Encode("query", filter) 125 } 126 if top != nil { 127 queryParameters["$top"] = autorest.Encode("query", *top) 128 } 129 if skip != nil { 130 queryParameters["$skip"] = autorest.Encode("query", *skip) 131 } 132 133 preparer := autorest.CreatePreparer( 134 autorest.AsGet(), 135 autorest.WithBaseURL(client.BaseURI), 136 autorest.WithPathParameters("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions", pathParameters), 137 autorest.WithQueryParameters(queryParameters)) 138 return preparer.Prepare((&http.Request{}).WithContext(ctx)) 139} 140 141// ListSender sends the List request. The method will close the 142// http.Response Body if it receives an error. 143func (client UserSubscriptionClient) ListSender(req *http.Request) (*http.Response, error) { 144 sd := autorest.GetSendDecorators(req.Context(), azure.DoRetryWithRegistration(client.Client)) 145 return autorest.SendWithSender(client, req, sd...) 146} 147 148// ListResponder handles the response to the List request. The method always 149// closes the http.Response Body. 150func (client UserSubscriptionClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error) { 151 err = autorest.Respond( 152 resp, 153 client.ByInspecting(), 154 azure.WithErrorUnlessStatusCode(http.StatusOK), 155 autorest.ByUnmarshallingJSON(&result), 156 autorest.ByClosing()) 157 result.Response = autorest.Response{Response: resp} 158 return 159} 160 161// listNextResults retrieves the next set of results, if any. 162func (client UserSubscriptionClient) listNextResults(ctx context.Context, lastResults SubscriptionCollection) (result SubscriptionCollection, err error) { 163 req, err := lastResults.subscriptionCollectionPreparer(ctx) 164 if err != nil { 165 return result, autorest.NewErrorWithError(err, "apimanagement.UserSubscriptionClient", "listNextResults", nil, "Failure preparing next results request") 166 } 167 if req == nil { 168 return 169 } 170 resp, err := client.ListSender(req) 171 if err != nil { 172 result.Response = autorest.Response{Response: resp} 173 return result, autorest.NewErrorWithError(err, "apimanagement.UserSubscriptionClient", "listNextResults", resp, "Failure sending next results request") 174 } 175 result, err = client.ListResponder(resp) 176 if err != nil { 177 err = autorest.NewErrorWithError(err, "apimanagement.UserSubscriptionClient", "listNextResults", resp, "Failure responding to next results request") 178 } 179 return 180} 181 182// ListComplete enumerates all values, automatically crossing page boundaries as required. 183func (client UserSubscriptionClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, userID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error) { 184 if tracing.IsEnabled() { 185 ctx = tracing.StartSpan(ctx, fqdn+"/UserSubscriptionClient.List") 186 defer func() { 187 sc := -1 188 if result.Response().Response.Response != nil { 189 sc = result.page.Response().Response.Response.StatusCode 190 } 191 tracing.EndSpan(ctx, sc, err) 192 }() 193 } 194 result.page, err = client.List(ctx, resourceGroupName, serviceName, userID, filter, top, skip) 195 return 196} 197