Documentation ¶
Overview ¶
Package azureadb2c implements the Azure ARM Azureadb2c service API version 2020-05-01-preview.
CPIM Configuration Client
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type CloudError
- type ErrorAdditionalInfo
- type ErrorResponse
- type GuestUsagesClient
- func (client GuestUsagesClient) Create(ctx context.Context, resourceGroupName string, resourceName string, ...) (result GuestUsagesResource, err error)
- func (client GuestUsagesClient) CreatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client GuestUsagesClient) CreateResponder(resp *http.Response) (result GuestUsagesResource, err error)
- func (client GuestUsagesClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client GuestUsagesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result autorest.Response, err error)
- func (client GuestUsagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client GuestUsagesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client GuestUsagesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client GuestUsagesClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result GuestUsagesResource, err error)
- func (client GuestUsagesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client GuestUsagesClient) GetResponder(resp *http.Response) (result GuestUsagesResource, err error)
- func (client GuestUsagesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client GuestUsagesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result GuestUsagesResourceList, err error)
- func (client GuestUsagesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client GuestUsagesClient) ListByResourceGroupResponder(resp *http.Response) (result GuestUsagesResourceList, err error)
- func (client GuestUsagesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client GuestUsagesClient) ListBySubscription(ctx context.Context) (result GuestUsagesResourceList, err error)
- func (client GuestUsagesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client GuestUsagesClient) ListBySubscriptionResponder(resp *http.Response) (result GuestUsagesResourceList, err error)
- func (client GuestUsagesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client GuestUsagesClient) Update(ctx context.Context, resourceGroupName string, resourceName string, ...) (result GuestUsagesResource, err error)
- func (client GuestUsagesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client GuestUsagesClient) UpdateResponder(resp *http.Response) (result GuestUsagesResource, err error)
- func (client GuestUsagesClient) UpdateSender(req *http.Request) (*http.Response, error)
- type GuestUsagesResource
- type GuestUsagesResourceList
- type GuestUsagesResourcePatch
- type GuestUsagesResourceProperties
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Azureadb2c
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type BaseClient ¶
BaseClient is the base client for Azureadb2c.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type CloudError ¶
type CloudError struct {
Error *ErrorResponse `json:"error,omitempty"`
}
CloudError an error response for a resource management request.
type ErrorAdditionalInfo ¶
type ErrorAdditionalInfo struct { // Type - READ-ONLY; The additional info type. Type *string `json:"type,omitempty"` // Info - READ-ONLY; The additional info. Info interface{} `json:"info,omitempty"` }
ErrorAdditionalInfo the resource management error additional info.
type ErrorResponse ¶
type ErrorResponse struct { // Code - READ-ONLY; The error code. Code *string `json:"code,omitempty"` // Message - READ-ONLY; The error message. Message *string `json:"message,omitempty"` // Target - READ-ONLY; The error target. Target *string `json:"target,omitempty"` // Details - READ-ONLY; The error details. Details *[]ErrorResponse `json:"details,omitempty"` // AdditionalInfo - READ-ONLY; The error additional info. AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"` }
ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
type GuestUsagesClient ¶
type GuestUsagesClient struct {
BaseClient
}
GuestUsagesClient is the CPIM Configuration Client
func NewGuestUsagesClient ¶
func NewGuestUsagesClient(subscriptionID string) GuestUsagesClient
NewGuestUsagesClient creates an instance of the GuestUsagesClient client.
func NewGuestUsagesClientWithBaseURI ¶
func NewGuestUsagesClientWithBaseURI(baseURI string, subscriptionID string) GuestUsagesClient
NewGuestUsagesClientWithBaseURI creates an instance of the GuestUsagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (GuestUsagesClient) Create ¶
func (client GuestUsagesClient) Create(ctx context.Context, resourceGroupName string, resourceName string, resource *GuestUsagesResource) (result GuestUsagesResource, err error)
Create creates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the AAD tenant. resource - guest Usages resource to be created
func (GuestUsagesClient) CreatePreparer ¶
func (client GuestUsagesClient) CreatePreparer(ctx context.Context, resourceGroupName string, resourceName string, resource *GuestUsagesResource) (*http.Request, error)
CreatePreparer prepares the Create request.
func (GuestUsagesClient) CreateResponder ¶
func (client GuestUsagesClient) CreateResponder(resp *http.Response) (result GuestUsagesResource, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (GuestUsagesClient) CreateSender ¶
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (GuestUsagesClient) Delete ¶
func (client GuestUsagesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result autorest.Response, err error)
Delete deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the AAD tenant.
func (GuestUsagesClient) DeletePreparer ¶
func (client GuestUsagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (GuestUsagesClient) DeleteResponder ¶
func (client GuestUsagesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (GuestUsagesClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (GuestUsagesClient) Get ¶
func (client GuestUsagesClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result GuestUsagesResource, err error)
Get gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the AAD tenant.
func (GuestUsagesClient) GetPreparer ¶
func (client GuestUsagesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (GuestUsagesClient) GetResponder ¶
func (client GuestUsagesClient) GetResponder(resp *http.Response) (result GuestUsagesResource, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (GuestUsagesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (GuestUsagesClient) ListByResourceGroup ¶
func (client GuestUsagesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result GuestUsagesResourceList, err error)
ListByResourceGroup gets Guest Usages resources under a resource group for the Microsoft.AzureActiveDirectory resource provider Parameters: resourceGroupName - the name of the resource group.
func (GuestUsagesClient) ListByResourceGroupPreparer ¶
func (client GuestUsagesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (GuestUsagesClient) ListByResourceGroupResponder ¶
func (client GuestUsagesClient) ListByResourceGroupResponder(resp *http.Response) (result GuestUsagesResourceList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (GuestUsagesClient) ListByResourceGroupSender ¶
func (client GuestUsagesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (GuestUsagesClient) ListBySubscription ¶
func (client GuestUsagesClient) ListBySubscription(ctx context.Context) (result GuestUsagesResourceList, err error)
ListBySubscription gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory resource provider
func (GuestUsagesClient) ListBySubscriptionPreparer ¶
func (client GuestUsagesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (GuestUsagesClient) ListBySubscriptionResponder ¶
func (client GuestUsagesClient) ListBySubscriptionResponder(resp *http.Response) (result GuestUsagesResourceList, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (GuestUsagesClient) ListBySubscriptionSender ¶
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (GuestUsagesClient) Update ¶
func (client GuestUsagesClient) Update(ctx context.Context, resourceGroupName string, resourceName string, resourcePatch *GuestUsagesResourcePatch) (result GuestUsagesResource, err error)
Update updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the AAD tenant. resourcePatch - guest Usages Resource to be updated
func (GuestUsagesClient) UpdatePreparer ¶
func (client GuestUsagesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, resourcePatch *GuestUsagesResourcePatch) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (GuestUsagesClient) UpdateResponder ¶
func (client GuestUsagesClient) UpdateResponder(resp *http.Response) (result GuestUsagesResource, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (GuestUsagesClient) UpdateSender ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type GuestUsagesResource ¶
type GuestUsagesResource struct { autorest.Response `json:"-"` // ID - READ-ONLY; An identifier that represents the Guest Usages resource. ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the Guest Usages resource. Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the Guest Usages resource. Type *string `json:"type,omitempty"` // Location - Location of the Guest Usages resource. Location *string `json:"location,omitempty"` // Tags - Key-value pairs of additional resource provisioning properties. Tags map[string]*string `json:"tags"` // GuestUsagesResourceProperties - The Guest Usages Resource Properties *GuestUsagesResourceProperties `json:"properties,omitempty"` }
GuestUsagesResource guest Usages Resource
func (GuestUsagesResource) MarshalJSON ¶
func (gur GuestUsagesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GuestUsagesResource.
func (*GuestUsagesResource) UnmarshalJSON ¶
func (gur *GuestUsagesResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GuestUsagesResource struct.
type GuestUsagesResourceList ¶
type GuestUsagesResourceList struct { autorest.Response `json:"-"` // Value - READ-ONLY; List of guest usages resources Value *[]GuestUsagesResource `json:"value,omitempty"` }
GuestUsagesResourceList the collection of guest usages resources
type GuestUsagesResourcePatch ¶
type GuestUsagesResourcePatch struct { // Tags - Key-value pairs of additional resource provisioning properties. Tags map[string]*string `json:"tags"` }
GuestUsagesResourcePatch guest Usages Resource for Patch
func (GuestUsagesResourcePatch) MarshalJSON ¶
func (gurp GuestUsagesResourcePatch) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GuestUsagesResourcePatch.
type GuestUsagesResourceProperties ¶
type GuestUsagesResourceProperties struct { // TenantID - An identifier for the tenant for which the resource is being created TenantID *string `json:"tenantId,omitempty"` }
GuestUsagesResourceProperties guest Usages Resource Properties
type Operation ¶
type Operation struct { // Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}. Name *string `json:"name,omitempty"` // Display - The object that represents the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation microsoft.AzureActiveDirectory REST API operation.
func (Operation) MarshalJSON ¶
MarshalJSON is the custom marshaler for Operation.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - READ-ONLY; Service provider: Microsoft.AzureActiveDirectory. Provider *string `json:"provider,omitempty"` // Resource - READ-ONLY; Resource on which the operation is performed: GuestUsages, etc. Resource *string `json:"resource,omitempty"` // Operation - READ-ONLY; Operation type: Read, write, delete, etc. Operation *string `json:"operation,omitempty"` // Description - Friendly name of the operation Description *string `json:"description,omitempty"` }
OperationDisplay the object that represents the operation.
func (OperationDisplay) MarshalJSON ¶
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplay.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; List of cpim service operations supported by the Microsoft.AzureActiveDirectory resource provider. Value *[]Operation `json:"value,omitempty"` }
OperationListResult result of listing operations for the resourceProvider
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the CPIM Configuration Client
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List lists the operations available from this provider.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.