const (
// DefaultBaseURI is the default URI used for the service Azureadexternalidentities
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
AvailableOperations available operations of the service
type AvailableOperations struct {
autorest.Response `json:"-"`
// Value - Collection of available operation details
Value *[]OperationDetail `json:"value,omitempty"`
// NextLink - URL client should use to fetch the next page (per server side paging).
// It's null for now, added for future use.
NextLink *string `json:"nextLink,omitempty"`
}
B2CResourceSKU SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling(https://aka.ms/b2cBilling).
type B2CResourceSKU struct {
// Name - The name of the SKU for the tenant. Possible values include: 'B2CResourceSKUNameStandard', 'B2CResourceSKUNamePremiumP1', 'B2CResourceSKUNamePremiumP2'
Name B2CResourceSKUName `json:"name,omitempty"`
// Tier - The tier of the tenant. Possible values include: 'B2CResourceSKUTierA0'
Tier B2CResourceSKUTier `json:"tier,omitempty"`
}
B2CResourceSKUName enumerates the values for b2c resource sku name.
type B2CResourceSKUName string
const (
// B2CResourceSKUNamePremiumP1 Azure AD B2C usage is billed to a linked Azure subscription and uses number
// of authentications based billing.
B2CResourceSKUNamePremiumP1 B2CResourceSKUName = "PremiumP1"
// B2CResourceSKUNamePremiumP2 Azure AD B2C usage is billed to a linked Azure subscription and uses number
// of authentications based billing.
B2CResourceSKUNamePremiumP2 B2CResourceSKUName = "PremiumP2"
// B2CResourceSKUNameStandard Azure AD B2C usage is billed to a linked Azure subscription and uses a
// monthly active users (MAU) billing model.
B2CResourceSKUNameStandard B2CResourceSKUName = "Standard"
)
func PossibleB2CResourceSKUNameValues() []B2CResourceSKUName
PossibleB2CResourceSKUNameValues returns an array of possible values for the B2CResourceSKUName const type.
B2CResourceSKUTier enumerates the values for b2c resource sku tier.
type B2CResourceSKUTier string
const (
// B2CResourceSKUTierA0 The SKU tier used for all Azure AD B2C tenants.
B2CResourceSKUTierA0 B2CResourceSKUTier = "A0"
)
func PossibleB2CResourceSKUTierValues() []B2CResourceSKUTier
PossibleB2CResourceSKUTierValues returns an array of possible values for the B2CResourceSKUTier const type.
B2CTenantResource ...
type B2CTenantResource struct {
autorest.Response `json:"-"`
// Type - READ-ONLY; The type of the B2C tenant resource. Possible values include: 'TypeValueMicrosoftAzureActiveDirectoryb2cDirectories'
Type TypeValue `json:"type,omitempty"`
Sku *B2CResourceSKU `json:"sku,omitempty"`
// B2CTenantResourceProperties - The Azure AD B2C tenant resource properties
*B2CTenantResourceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; An identifier that represents the Azure AD B2C tenant resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the Azure AD B2C tenant resource.
Name *string `json:"name,omitempty"`
// Location - The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to [this documentation](https://aka.ms/B2CDataResidency) for more information.
Location *string `json:"location,omitempty"`
// Tags - Resource Tags
Tags map[string]*string `json:"tags"`
// SystemData - READ-ONLY
SystemData *SystemData `json:"systemData,omitempty"`
}
func (btr B2CTenantResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for B2CTenantResource.
func (btr *B2CTenantResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for B2CTenantResource struct.
B2CTenantResourceList the collection of Azure AD B2C tenant resources
type B2CTenantResourceList struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Azure AD B2C tenant resources
Value *[]B2CTenantResource `json:"value,omitempty"`
}
func (btrl B2CTenantResourceList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for B2CTenantResourceList.
B2CTenantResourceProperties properties of the Azure AD B2C tenant Azure resource.
type B2CTenantResourceProperties struct {
// BillingConfig - The billing configuration for the tenant.
BillingConfig *B2CTenantResourcePropertiesBillingConfig `json:"billingConfig,omitempty"`
// TenantID - An identifier of the Azure AD B2C tenant.
TenantID *string `json:"tenantId,omitempty"`
}
B2CTenantResourcePropertiesBillingConfig the billing configuration for the tenant.
type B2CTenantResourcePropertiesBillingConfig struct {
// BillingType - The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cbilling). Possible values include: 'BillingTypeMAU', 'BillingTypeAuths'
BillingType BillingType `json:"billingType,omitempty"`
// EffectiveStartDateUtc - READ-ONLY; The data from which the billing type took effect
EffectiveStartDateUtc *string `json:"effectiveStartDateUtc,omitempty"`
}
func (btrpC B2CTenantResourcePropertiesBillingConfig) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for B2CTenantResourcePropertiesBillingConfig.
B2CTenantUpdateRequest the request body to update the Azure AD B2C tenant resource.
type B2CTenantUpdateRequest struct {
Sku *B2CResourceSKU `json:"sku,omitempty"`
// B2CTenantResourceProperties - The Azure AD B2C tenant resource properties.
*B2CTenantResourceProperties `json:"properties,omitempty"`
// Tags - Resource Tags
Tags map[string]*string `json:"tags"`
}
func (btur B2CTenantUpdateRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for B2CTenantUpdateRequest.
func (btur *B2CTenantUpdateRequest) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for B2CTenantUpdateRequest struct.
B2CTenantsClient is the external Identities Configuration Client
type B2CTenantsClient struct {
BaseClient
}
func NewB2CTenantsClient(subscriptionID string) B2CTenantsClient
NewB2CTenantsClient creates an instance of the B2CTenantsClient client.
func NewB2CTenantsClientWithBaseURI(baseURI string, subscriptionID string) B2CTenantsClient
NewB2CTenantsClientWithBaseURI creates an instance of the B2CTenantsClient 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 (client B2CTenantsClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityRequestBody *CheckNameAvailabilityRequestBody) (result NameAvailabilityResponse, err error)
CheckNameAvailability checks the availability and validity of a domain name for the tenant.
func (client B2CTenantsClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityRequestBody *CheckNameAvailabilityRequestBody) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (client B2CTenantsClient) CheckNameAvailabilityResponder(resp *http.Response) (result NameAvailabilityResponse, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (client B2CTenantsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (client B2CTenantsClient) Create(ctx context.Context, resourceGroupName string, resourceName string, createTenantRequestBody *CreateTenantRequestBody) (result B2CTenantsCreateFuture, err error)
Create initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription. Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the Azure AD B2C tenant.
func (client B2CTenantsClient) CreatePreparer(ctx context.Context, resourceGroupName string, resourceName string, createTenantRequestBody *CreateTenantRequestBody) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client B2CTenantsClient) CreateResponder(resp *http.Response) (result B2CTenantResource, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client B2CTenantsClient) CreateSender(req *http.Request) (future B2CTenantsCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client B2CTenantsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result B2CTenantsDeleteFuture, err error)
Delete initiates an async operation to delete the Azure AD B2C tenant and Azure resource. The resource deletion can only happen as the last step in [the tenant deletion process](https://aka.ms/deleteB2Ctenant). Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the Azure AD B2C tenant.
func (client B2CTenantsClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client B2CTenantsClient) 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 (client B2CTenantsClient) DeleteSender(req *http.Request) (future B2CTenantsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client B2CTenantsClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result B2CTenantResource, err error)
Get get the Azure AD B2C tenant resource. Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the Azure AD B2C tenant.
func (client B2CTenantsClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client B2CTenantsClient) GetResponder(resp *http.Response) (result B2CTenantResource, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client B2CTenantsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client B2CTenantsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result B2CTenantResourceList, err error)
ListByResourceGroup get all the Azure AD B2C tenant resources in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client B2CTenantsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client B2CTenantsClient) ListByResourceGroupResponder(resp *http.Response) (result B2CTenantResourceList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client B2CTenantsClient) 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 (client B2CTenantsClient) ListBySubscription(ctx context.Context) (result B2CTenantResourceList, err error)
ListBySubscription get all the Azure AD B2C tenant resources in a subscription.
func (client B2CTenantsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client B2CTenantsClient) ListBySubscriptionResponder(resp *http.Response) (result B2CTenantResourceList, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client B2CTenantsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client B2CTenantsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, updateTenantRequestBody *B2CTenantUpdateRequest) (result B2CTenantResource, err error)
Update update the Azure AD B2C tenant resource. Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the Azure AD B2C tenant.
func (client B2CTenantsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, updateTenantRequestBody *B2CTenantUpdateRequest) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client B2CTenantsClient) UpdateResponder(resp *http.Response) (result B2CTenantResource, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client B2CTenantsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
B2CTenantsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type B2CTenantsCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(B2CTenantsClient) (B2CTenantResource, error)
}
func (future *B2CTenantsCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
B2CTenantsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type B2CTenantsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(B2CTenantsClient) (autorest.Response, error)
}
func (future *B2CTenantsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
BaseClient is the base client for Azureadexternalidentities.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
BillingType enumerates the values for billing type.
type BillingType string
const (
// BillingTypeAuths Azure AD B2C usage is billed to a linked Azure subscription and uses number of
// authentications based billing.
BillingTypeAuths BillingType = "Auths"
// BillingTypeMAU Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active
// users (MAU) billing model.
BillingTypeMAU BillingType = "MAU"
)
func PossibleBillingTypeValues() []BillingType
PossibleBillingTypeValues returns an array of possible values for the BillingType const type.
CheckNameAvailabilityRequestBody the information required to check the availability of the name for the tenant.
type CheckNameAvailabilityRequestBody struct {
// Name - The domain name to check for availability.
Name *string `json:"name,omitempty"`
CountryCode *string `json:"countryCode,omitempty"`
}
CloudError an error response for a resource management request.
type CloudError struct {
Error *ErrorResponse `json:"error,omitempty"`
}
CreateTenantProperties these properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource.
type CreateTenantProperties struct {
// DisplayName - The display name of the Azure AD B2C tenant.
DisplayName *string `json:"displayName,omitempty"`
CountryCode *string `json:"countryCode,omitempty"`
}
CreateTenantRequestBody the information needed to create the Azure AD B2C tenant and corresponding Azure resource, which is used for billing purposes.
type CreateTenantRequestBody struct {
// Location - The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to [this documentation](https://aka.ms/B2CDataResidency) for more information.
Location *string `json:"location,omitempty"`
*CreateTenantRequestBodyProperties `json:"properties,omitempty"`
Sku *B2CResourceSKU `json:"sku,omitempty"`
// Tags - Resource Tags
Tags map[string]*string `json:"tags"`
}
func (ctrb CreateTenantRequestBody) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateTenantRequestBody.
func (ctrb *CreateTenantRequestBody) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateTenantRequestBody struct.
CreateTenantRequestBodyProperties ...
type CreateTenantRequestBodyProperties struct {
*CreateTenantProperties `json:"createTenantProperties,omitempty"`
}
func (ctrb CreateTenantRequestBodyProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateTenantRequestBodyProperties.
func (ctrb *CreateTenantRequestBodyProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateTenantRequestBodyProperties struct.
CreatedByType enumerates the values for created by type.
type CreatedByType string
const (
// CreatedByTypeApplication ...
CreatedByTypeApplication CreatedByType = "Application"
// CreatedByTypeKey ...
CreatedByTypeKey CreatedByType = "Key"
// CreatedByTypeManagedIdentity ...
CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
// CreatedByTypeUser ...
CreatedByTypeUser CreatedByType = "User"
)
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.
ErrorAdditionalInfo the resource management error additional info.
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"`
}
func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorAdditionalInfo.
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 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"`
}
func (er ErrorResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorResponse.
GuestUsagesClient is the external Identities Configuration Client
type GuestUsagesClient struct {
BaseClient
}
func NewGuestUsagesClient(subscriptionID string) GuestUsagesClient
NewGuestUsagesClient creates an instance of the GuestUsagesClient client.
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 (client GuestUsagesClient) Create(ctx context.Context, resourceGroupName string, resourceName string, resource *GuestUsagesResource) (result GuestUsagesResource, err error)
Create creates a Guest Usages resource, which is used to linking a subscription to an instance of Azure AD External Identities. [Learn more](https://aka.ms/extidbilling). Parameters: resourceGroupName - the name of the resource group. resourceName - the initial domain name of the Azure AD B2C tenant. resource - guest Usages resource to be created
func (client GuestUsagesClient) CreatePreparer(ctx context.Context, resourceGroupName string, resourceName string, resource *GuestUsagesResource) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (client GuestUsagesClient) CreateSender(req *http.Request) (*http.Response, error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
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 Azure AD B2C tenant.
func (client GuestUsagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client GuestUsagesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
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 Azure AD B2C tenant.
func (client GuestUsagesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client GuestUsagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client GuestUsagesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (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 (client GuestUsagesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
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 (client GuestUsagesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
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 Azure AD B2C tenant. resourcePatch - guest Usages Resource to be updated
func (client GuestUsagesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, resourcePatch *GuestUsagesResourcePatch) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (client GuestUsagesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GuestUsagesResource guest Usages Resource
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"`
// SystemData - READ-ONLY
SystemData *SystemData `json:"systemData,omitempty"`
}
func (gur GuestUsagesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GuestUsagesResource.
func (gur *GuestUsagesResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GuestUsagesResource struct.
GuestUsagesResourceList the collection of guest usages resources
type GuestUsagesResourceList struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of guest usages resources
Value *[]GuestUsagesResource `json:"value,omitempty"`
}
func (gurl GuestUsagesResourceList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GuestUsagesResourceList.
GuestUsagesResourcePatch guest Usages Resource for Patch
type GuestUsagesResourcePatch struct {
// Tags - Key-value pairs of additional resource provisioning properties.
Tags map[string]*string `json:"tags"`
}
func (gurp GuestUsagesResourcePatch) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GuestUsagesResourcePatch.
GuestUsagesResourceProperties guest Usages Resource Properties
type GuestUsagesResourceProperties struct {
// TenantID - An identifier for the tenant for which the resource is being created
TenantID *string `json:"tenantId,omitempty"`
}
NameAvailabilityReasonType enumerates the values for name availability reason type.
type NameAvailabilityReasonType string
const (
// NameAvailabilityReasonTypeAlreadyExists The name is already in use and is therefore unavailable.
NameAvailabilityReasonTypeAlreadyExists NameAvailabilityReasonType = "AlreadyExists"
// NameAvailabilityReasonTypeInvalid The name provided does not match the resource provider’s naming
// requirements (incorrect length, unsupported characters, etc.).
NameAvailabilityReasonTypeInvalid NameAvailabilityReasonType = "Invalid"
)
func PossibleNameAvailabilityReasonTypeValues() []NameAvailabilityReasonType
PossibleNameAvailabilityReasonTypeValues returns an array of possible values for the NameAvailabilityReasonType const type.
NameAvailabilityResponse response of the CheckNameAvailability operation.
type NameAvailabilityResponse struct {
autorest.Response `json:"-"`
// Message - Description of the reason if name is not available.
Message *string `json:"message,omitempty"`
// NameAvailable - True if the name is available and can be used to create a new tenant. Otherwise false.
NameAvailable *bool `json:"nameAvailable,omitempty"`
// Reason - Possible values include: 'NameAvailabilityReasonTypeAlreadyExists', 'NameAvailabilityReasonTypeInvalid'
Reason NameAvailabilityReasonType `json:"reason,omitempty"`
}
OperationDetail operation detail payload
type OperationDetail struct {
// Name - Name of the operation
Name *string `json:"name,omitempty"`
// IsDataAction - Indicates whether the operation is a data action
IsDataAction *bool `json:"isDataAction,omitempty"`
// Display - Display of the operation
Display *OperationDisplay `json:"display,omitempty"`
// Origin - Origin of the operation
Origin *string `json:"origin,omitempty"`
}
OperationDisplay operation display payload
type OperationDisplay struct {
// Provider - Resource provider of the operation
Provider *string `json:"provider,omitempty"`
// Resource - Resource of the operation
Resource *string `json:"resource,omitempty"`
// Operation - Localized friendly name for the operation
Operation *string `json:"operation,omitempty"`
// Description - Localized friendly description for the operation
Description *string `json:"description,omitempty"`
}
OperationsClient is the external Identities Configuration Client
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (client OperationsClient) List(ctx context.Context) (result AvailableOperations, err error)
List lists the operations available from this provider.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result AvailableOperations, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
SystemData metadata pertaining to creation and last modification of the resource.
type SystemData struct {
// CreatedBy - The identity that created the resource.
CreatedBy *string `json:"createdBy,omitempty"`
// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
CreatedByType CreatedByType `json:"createdByType,omitempty"`
// CreatedAt - The timestamp of resource creation (UTC).
CreatedAt *date.Time `json:"createdAt,omitempty"`
// LastModifiedBy - The identity that last modified the resource.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
// LastModifiedAt - The timestamp of resource last modification (UTC)
LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}
TypeValue enumerates the values for type value.
type TypeValue string
const (
// TypeValueMicrosoftAzureActiveDirectoryb2cDirectories The resource type for Azure AD B2C tenant resource.
TypeValueMicrosoftAzureActiveDirectoryb2cDirectories TypeValue = "Microsoft.AzureActiveDirectory/b2cDirectories"
)
func PossibleTypeValueValues() []TypeValue
PossibleTypeValueValues returns an array of possible values for the TypeValue const type.
| Name | Synopsis |
|---|---|
| .. | |
| azureadexternalidentitiesapi | Deprecated: Please note, this package has been deprecated. |