Table of Contents

Class ResourceManagerModelFactory

Namespace
Azure.ResourceManager.Models
Assembly
Azure.ResourceManager.dll

Model factory for read-only models.

public static class ResourceManagerModelFactory
Inheritance
ResourceManagerModelFactory
Inherited Members

Methods

ApiProfile(string, string)

Initializes a new instance of ApiProfile.

public static ApiProfile ApiProfile(string profileVersion = null, string apiVersion = null)

Parameters

profileVersion string

The profile version.

apiVersion string

The API version.

Returns

ApiProfile

A new ApiProfile instance for mocking.

AvailabilityZoneMappings(string, string)

Initializes a new instance of AvailabilityZoneMappings.

public static AvailabilityZoneMappings AvailabilityZoneMappings(string logicalZone = null, string physicalZone = null)

Parameters

logicalZone string

The logical zone id for the availability zone.

physicalZone string

The fully qualified physical zone id of availability zone to which logical zone id is mapped to.

Returns

AvailabilityZoneMappings

A new AvailabilityZoneMappings instance for mocking.

AzureRoleDefinition(string, string, bool?, IEnumerable<Permission>, IEnumerable<string>)

Initializes a new instance of AzureRoleDefinition.

public static AzureRoleDefinition AzureRoleDefinition(string id = null, string name = null, bool? isServiceRole = null, IEnumerable<Permission> permissions = null, IEnumerable<string> scopes = null)

Parameters

id string

The role definition ID.

name string

The role definition name.

isServiceRole bool?

If this is a service role.

permissions IEnumerable<Permission>

Role definition permissions.

scopes IEnumerable<string>

Role definition assignable scopes.

Returns

AzureRoleDefinition

A new AzureRoleDefinition instance for mocking.

CreateManagementGroupDetails(int?, DateTimeOffset?, string, ManagementGroupParentCreateOptions)

Initializes a new instance of CreateManagementGroupDetails.

public static CreateManagementGroupDetails CreateManagementGroupDetails(int? version = null, DateTimeOffset? updatedOn = null, string updatedBy = null, ManagementGroupParentCreateOptions parent = null)

Parameters

version int?

The version number of the object.

updatedOn DateTimeOffset?

The date and time when this object was last updated.

updatedBy string

The identity of the principal or process that updated the object.

parent ManagementGroupParentCreateOptions

(Optional) The ID of the parent management group used during creation.

Returns

CreateManagementGroupDetails

A new CreateManagementGroupDetails instance for mocking.

DataManifestCustomResourceFunctionDefinition(string, ResourceType?, IEnumerable<string>, bool?)

Initializes a new instance of DataManifestCustomResourceFunctionDefinition.

public static DataManifestCustomResourceFunctionDefinition DataManifestCustomResourceFunctionDefinition(string name = null, ResourceType? fullyQualifiedResourceType = null, IEnumerable<string> defaultProperties = null, bool? allowCustomProperties = null)

Parameters

name string

The function name as it will appear in the policy rule. eg - 'vault'.

fullyQualifiedResourceType ResourceType?

The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'.

defaultProperties IEnumerable<string>

The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported.

allowCustomProperties bool?

A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01').

Returns

DataManifestCustomResourceFunctionDefinition

A new DataManifestCustomResourceFunctionDefinition instance for mocking.

DataPolicyManifestData(ResourceIdentifier, string, ResourceType, SystemData, IEnumerable<string>, string, bool?, IEnumerable<ResourceTypeAliases>, IEnumerable<DataPolicyManifestEffect>, IEnumerable<string>, IEnumerable<string>, IEnumerable<DataManifestCustomResourceFunctionDefinition>)

Initializes a new instance of DataPolicyManifestData.

public static DataPolicyManifestData DataPolicyManifestData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, IEnumerable<string> namespaces = null, string policyMode = null, bool? isBuiltInOnly = null, IEnumerable<ResourceTypeAliases> resourceTypeAliases = null, IEnumerable<DataPolicyManifestEffect> effects = null, IEnumerable<string> fieldValues = null, IEnumerable<string> standard = null, IEnumerable<DataManifestCustomResourceFunctionDefinition> customDefinitions = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

namespaces IEnumerable<string>

The list of namespaces for the data policy manifest.

policyMode string

The policy mode of the data policy manifest.

isBuiltInOnly bool?

A value indicating whether policy mode is allowed only in built-in definitions.

resourceTypeAliases IEnumerable<ResourceTypeAliases>

An array of resource type aliases.

effects IEnumerable<DataPolicyManifestEffect>

The effect definition.

fieldValues IEnumerable<string>

The non-alias field accessor values that can be used in the policy rule.

standard IEnumerable<string>

The standard resource functions (subscription and/or resourceGroup).

customDefinitions IEnumerable<DataManifestCustomResourceFunctionDefinition>

An array of data manifest custom resource definition.

Returns

DataPolicyManifestData

A new DataPolicyManifestData instance for mocking.

DataPolicyManifestEffect(string, BinaryData)

Initializes a new instance of DataPolicyManifestEffect.

public static DataPolicyManifestEffect DataPolicyManifestEffect(string name = null, BinaryData detailsSchema = null)

Parameters

name string

The data effect name.

detailsSchema BinaryData

The data effect details schema.

Returns

DataPolicyManifestEffect

A new DataPolicyManifestEffect instance for mocking.

DescendantData(ResourceIdentifier, string, ResourceType, SystemData, string, ResourceIdentifier)

Initializes a new instance of DescendantData.

public static DescendantData DescendantData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, string displayName = null, ResourceIdentifier parentId = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

displayName string

The friendly name of the management group.

parentId ResourceIdentifier

The ID of the parent management group.

Returns

DescendantData

A new DescendantData instance for mocking.

EntityData(ResourceIdentifier, string, ResourceType, SystemData, Guid?, string, ResourceIdentifier, EntityPermission?, EntityPermission?, int?, int?, int?, IEnumerable<string>, IEnumerable<string>)

Initializes a new instance of EntityData.

public static EntityData EntityData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, Guid? tenantId = null, string displayName = null, ResourceIdentifier parentId = null, EntityPermission? permissions = null, EntityPermission? inheritedPermissions = null, int? numberOfDescendants = null, int? numberOfChildren = null, int? numberOfChildGroups = null, IEnumerable<string> parentDisplayNameChain = null, IEnumerable<string> parentNameChain = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

tenantId Guid?

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000.

displayName string

The friendly name of the management group.

parentId ResourceIdentifier

(Optional) The ID of the parent management group.

permissions EntityPermission?

The users specific permissions to this item.

inheritedPermissions EntityPermission?

The users specific permissions to this item.

numberOfDescendants int?

Number of Descendants.

numberOfChildren int?

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

numberOfChildGroups int?

Number of children is the number of Groups that are exactly one level underneath the current Group.

parentDisplayNameChain IEnumerable<string>

The parent display name chain from the root group to the immediate parent.

parentNameChain IEnumerable<string>

The parent name chain from the root group to the immediate parent.

Returns

EntityData

A new EntityData instance for mocking.

FeatureData(ResourceIdentifier, string, ResourceType, SystemData, string)

Initializes a new instance of FeatureData.

public static FeatureData FeatureData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, string featureState = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

featureState string

Properties of the previewed feature.

Returns

FeatureData

A new FeatureData instance for mocking.

GenericResourceData(ResourceIdentifier, string, ResourceType, SystemData, IDictionary<string, string>, AzureLocation, ExtendedLocation, ArmPlan, BinaryData, string, string, ResourcesSku, ManagedServiceIdentity, DateTimeOffset?, DateTimeOffset?, string)

Initializes a new instance of GenericResourceData.

public static GenericResourceData GenericResourceData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, IDictionary<string, string> tags = null, AzureLocation location = null, ExtendedLocation extendedLocation = null, ArmPlan plan = null, BinaryData properties = null, string kind = null, string managedBy = null, ResourcesSku sku = null, ManagedServiceIdentity identity = null, DateTimeOffset? createdOn = null, DateTimeOffset? changedOn = null, string provisioningState = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

tags IDictionary<string, string>

The tags.

location AzureLocation

The location.

extendedLocation ExtendedLocation

Resource extended location.

plan ArmPlan

The plan of the resource.

properties BinaryData

The resource properties.

kind string

The kind of the resource.

managedBy string

ID of the resource that manages this resource.

sku ResourcesSku

The SKU of the resource.

identity ManagedServiceIdentity

The identity of the resource.

createdOn DateTimeOffset?

The created time of the resource. This is only present if requested via the $expand query parameter.

changedOn DateTimeOffset?

The changed time of the resource. This is only present if requested via the $expand query parameter.

provisioningState string

The provisioning state of the resource. This is only present if requested via the $expand query parameter.

Returns

GenericResourceData

A new GenericResourceData instance for mocking.

LocationExpanded(string, string, string, LocationType?, string, string, LocationMetadata)

Initializes a new instance of LocationExpanded.

public static LocationExpanded LocationExpanded(string id, string subscriptionId, string name, LocationType? locationType, string displayName, string regionalDisplayName, LocationMetadata metadata)

Parameters

id string

The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus.

subscriptionId string

The subscription ID.

name string

The location name.

locationType LocationType?

The location type.

displayName string

The display name of the location.

regionalDisplayName string

The display name of the location and its region.

metadata LocationMetadata

Metadata of the location, such as lat/long, paired region, and others.

Returns

LocationExpanded

A new LocationExpanded instance for mocking.

LocationExpanded(string, string, string, LocationType?, string, string, LocationMetadata, IEnumerable<AvailabilityZoneMappings>)

Initializes a new instance of LocationExpanded.

public static LocationExpanded LocationExpanded(string id = null, string subscriptionId = null, string name = null, LocationType? locationType = null, string displayName = null, string regionalDisplayName = null, LocationMetadata metadata = null, IEnumerable<AvailabilityZoneMappings> availabilityZoneMappings = null)

Parameters

id string

The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.

subscriptionId string

The subscription ID.

name string

The location name.

locationType LocationType?

The location type.

displayName string

The display name of the location.

regionalDisplayName string

The display name of the location and its region.

metadata LocationMetadata

Metadata of the location, such as lat/long, paired region, and others.

availabilityZoneMappings IEnumerable<AvailabilityZoneMappings>

The availability zone mappings for this region.

Returns

LocationExpanded

A new LocationExpanded instance for mocking.

LocationMetadata(RegionType?, RegionCategory?, string, string, double?, double?, string, IEnumerable<PairedRegion>, string)

Initializes a new instance of LocationMetadata.

public static LocationMetadata LocationMetadata(RegionType? regionType = null, RegionCategory? regionCategory = null, string geography = null, string geographyGroup = null, double? longitude = null, double? latitude = null, string physicalLocation = null, IEnumerable<PairedRegion> pairedRegions = null, string homeLocation = null)

Parameters

regionType RegionType?

The type of the region.

regionCategory RegionCategory?

The category of the region.

geography string

The geography of the location.

geographyGroup string

The geography group of the location.

longitude double?

The longitude of the location.

latitude double?

The latitude of the location.

physicalLocation string

The physical location of the Azure location.

pairedRegions IEnumerable<PairedRegion>

The regions paired to this region.

homeLocation string

The home location of an edge zone.

Returns

LocationMetadata

A new LocationMetadata instance for mocking.

ManagedByTenant(Guid?)

Initializes a new instance of ManagedByTenant.

public static ManagedByTenant ManagedByTenant(Guid? tenantId = null)

Parameters

tenantId Guid?

The tenant ID of the managing tenant. This is a GUID.

Returns

ManagedByTenant

A new ManagedByTenant instance for mocking.

ManagedServiceIdentity(Guid?, Guid?, ManagedServiceIdentityType, IDictionary<ResourceIdentifier, UserAssignedIdentity>)

Initializes a new instance of LocationExpanded.

public static ManagedServiceIdentity ManagedServiceIdentity(Guid? principalId = null, Guid? tenantId = null, ManagedServiceIdentityType managedServiceIdentityType = default, IDictionary<ResourceIdentifier, UserAssignedIdentity> userAssignedIdentities = null)

Parameters

principalId Guid?

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId Guid?

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

managedServiceIdentityType ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

userAssignedIdentities IDictionary<ResourceIdentifier, UserAssignedIdentity>

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

Returns

ManagedServiceIdentity

A new ManagedServiceIdentity instance for mocking.

ManagementGroupChildInfo(ManagementGroupChildType?, string, string, string, IEnumerable<ManagementGroupChildInfo>)

Initializes a new instance of ManagementGroupChildInfo.

public static ManagementGroupChildInfo ManagementGroupChildInfo(ManagementGroupChildType? childType = null, string id = null, string name = null, string displayName = null, IEnumerable<ManagementGroupChildInfo> children = null)

Parameters

childType ManagementGroupChildType?

The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups).

id string

The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

name string

The name of the child entity.

displayName string

The friendly name of the child resource.

children IEnumerable<ManagementGroupChildInfo>

The list of children.

Returns

ManagementGroupChildInfo

A new ManagementGroupChildInfo instance for mocking.

ManagementGroupChildOptions(ManagementGroupChildType?, string, string, string, IEnumerable<ManagementGroupChildOptions>)

Initializes a new instance of ManagementGroupChildOptions.

public static ManagementGroupChildOptions ManagementGroupChildOptions(ManagementGroupChildType? childType = null, string id = null, string name = null, string displayName = null, IEnumerable<ManagementGroupChildOptions> children = null)

Parameters

childType ManagementGroupChildType?

The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups).

id string

The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

name string

The name of the child entity.

displayName string

The friendly name of the child resource.

children IEnumerable<ManagementGroupChildOptions>

The list of children.

Returns

ManagementGroupChildOptions

A new ManagementGroupChildOptions instance for mocking.

ManagementGroupCreateOrUpdateContent(string, ResourceType?, string, Guid?, string, CreateManagementGroupDetails, IEnumerable<ManagementGroupChildOptions>)

Initializes a new instance of ManagementGroupCreateOrUpdateContent.

public static ManagementGroupCreateOrUpdateContent ManagementGroupCreateOrUpdateContent(string id = null, ResourceType? resourceType = null, string name = null, Guid? tenantId = null, string displayName = null, CreateManagementGroupDetails details = null, IEnumerable<ManagementGroupChildOptions> children = null)

Parameters

id string

The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

resourceType ResourceType?

The type of the resource. For example, Microsoft.Management/managementGroups.

name string

The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

tenantId Guid?

The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

displayName string

The friendly name of the management group. If no value is passed then this field will be set to the groupId.

details CreateManagementGroupDetails

The details of a management group used during creation.

children IEnumerable<ManagementGroupChildOptions>

The list of children.

Returns

ManagementGroupCreateOrUpdateContent

A new ManagementGroupCreateOrUpdateContent instance for mocking.

ManagementGroupData(ResourceIdentifier, string, ResourceType, SystemData, Guid?, string, ManagementGroupInfo, IEnumerable<ManagementGroupChildInfo>)

Initializes a new instance of ManagementGroupData.

public static ManagementGroupData ManagementGroupData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, Guid? tenantId = null, string displayName = null, ManagementGroupInfo details = null, IEnumerable<ManagementGroupChildInfo> children = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

tenantId Guid?

The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

displayName string

The friendly name of the management group.

details ManagementGroupInfo

The details of a management group.

children IEnumerable<ManagementGroupChildInfo>

The list of children.

Returns

ManagementGroupData

A new ManagementGroupData instance for mocking.

ManagementGroupInfo(int?, DateTimeOffset?, string, ParentManagementGroupInfo, IEnumerable<ManagementGroupPathElement>, IEnumerable<string>, IEnumerable<ManagementGroupPathElement>)

Initializes a new instance of ManagementGroupInfo.

public static ManagementGroupInfo ManagementGroupInfo(int? version = null, DateTimeOffset? updatedOn = null, string updatedBy = null, ParentManagementGroupInfo parent = null, IEnumerable<ManagementGroupPathElement> path = null, IEnumerable<string> managementGroupAncestors = null, IEnumerable<ManagementGroupPathElement> managementGroupAncestorChain = null)

Parameters

version int?

The version number of the object.

updatedOn DateTimeOffset?

The date and time when this object was last updated.

updatedBy string

The identity of the principal or process that updated the object.

parent ParentManagementGroupInfo

(Optional) The ID of the parent management group.

path IEnumerable<ManagementGroupPathElement>

The path from the root to the current group.

managementGroupAncestors IEnumerable<string>

The ancestors of the management group.

managementGroupAncestorChain IEnumerable<ManagementGroupPathElement>

The ancestors of the management group displayed in reversed order, from immediate parent to the root.

Returns

ManagementGroupInfo

A new ManagementGroupInfo instance for mocking.

ManagementGroupNameAvailabilityResult(bool?, ManagementGroupNameUnavailableReason?, string)

Initializes a new instance of ManagementGroupNameAvailabilityResult.

public static ManagementGroupNameAvailabilityResult ManagementGroupNameAvailabilityResult(bool? nameAvailable = null, ManagementGroupNameUnavailableReason? reason = null, string message = null)

Parameters

nameAvailable bool?

Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.

reason ManagementGroupNameUnavailableReason?

Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

message string

Required if nameAvailable == false. Localized. If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.

Returns

ManagementGroupNameAvailabilityResult

A new ManagementGroupNameAvailabilityResult instance for mocking.

ManagementGroupParentCreateOptions(string, string, string)

Initializes a new instance of ManagementGroupParentCreateOptions.

public static ManagementGroupParentCreateOptions ManagementGroupParentCreateOptions(string id = null, string name = null, string displayName = null)

Parameters

id string

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

name string

The name of the parent management group.

displayName string

The friendly name of the parent management group.

Returns

ManagementGroupParentCreateOptions

A new ManagementGroupParentCreateOptions instance for mocking.

ManagementGroupPathElement(string, string)

Initializes a new instance of ManagementGroupPathElement.

public static ManagementGroupPathElement ManagementGroupPathElement(string name = null, string displayName = null)

Parameters

name string

The name of the group.

displayName string

The friendly name of the group.

Returns

ManagementGroupPathElement

A new ManagementGroupPathElement instance for mocking.

ManagementGroupSubscriptionData(ResourceIdentifier, string, ResourceType, SystemData, string, string, ResourceIdentifier, string)

Initializes a new instance of ManagementGroupSubscriptionData.

public static ManagementGroupSubscriptionData ManagementGroupSubscriptionData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, string tenant = null, string displayName = null, ResourceIdentifier parentId = null, string state = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

tenant string

The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000.

displayName string

The friendly name of the subscription.

parentId ResourceIdentifier

The ID of the parent management group.

state string

The state of the subscription.

Returns

ManagementGroupSubscriptionData

A new ManagementGroupSubscriptionData instance for mocking.

ManagementLockData(ResourceIdentifier, string, ResourceType, SystemData, ManagementLockLevel, string, IEnumerable<ManagementLockOwner>)

Initializes a new instance of ManagementLockData.

public static ManagementLockData ManagementLockData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, ManagementLockLevel level = default, string notes = null, IEnumerable<ManagementLockOwner> owners = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

level ManagementLockLevel

The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it.

notes string

Notes about the lock. Maximum of 512 characters.

owners IEnumerable<ManagementLockOwner>

The owners of the lock.

Returns

ManagementLockData

A new ManagementLockData instance for mocking.

PairedRegion(string, string, string)

Initializes a new instance of PairedRegion.

public static PairedRegion PairedRegion(string name = null, string id = null, string subscriptionId = null)

Parameters

name string

The name of the paired region.

id string

The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.

subscriptionId string

The subscription ID.

Returns

PairedRegion

A new PairedRegion instance for mocking.

ParentManagementGroupInfo(string, string, string)

Initializes a new instance of ParentManagementGroupInfo.

public static ParentManagementGroupInfo ParentManagementGroupInfo(string id = null, string name = null, string displayName = null)

Parameters

id string

The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

name string

The name of the parent management group.

displayName string

The friendly name of the parent management group.

Returns

ParentManagementGroupInfo

A new ParentManagementGroupInfo instance for mocking.

Permission(IEnumerable<string>, IEnumerable<string>, IEnumerable<string>, IEnumerable<string>)

Initializes a new instance of Permission.

public static Permission Permission(IEnumerable<string> allowedActions = null, IEnumerable<string> deniedActions = null, IEnumerable<string> allowedDataActions = null, IEnumerable<string> deniedDataActions = null)

Parameters

allowedActions IEnumerable<string>

Allowed actions.

deniedActions IEnumerable<string>

Denied actions.

allowedDataActions IEnumerable<string>

Allowed Data actions.

deniedDataActions IEnumerable<string>

Denied Data actions.

Returns

Permission

A new Permission instance for mocking.

PolicyAssignmentData(ResourceIdentifier, string, ResourceType, SystemData, AzureLocation?, ManagedServiceIdentity, string, string, string, IEnumerable<string>, IDictionary<string, ArmPolicyParameterValue>, string, BinaryData, EnforcementMode?, IEnumerable<NonComplianceMessage>, IEnumerable<ResourceSelector>, IEnumerable<PolicyOverride>)

Initializes a new instance of PolicyAssignmentData.

public static PolicyAssignmentData PolicyAssignmentData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, AzureLocation? location = null, ManagedServiceIdentity managedIdentity = null, string displayName = null, string policyDefinitionId = null, string scope = null, IEnumerable<string> excludedScopes = null, IDictionary<string, ArmPolicyParameterValue> parameters = null, string description = null, BinaryData metadata = null, EnforcementMode? enforcementMode = null, IEnumerable<NonComplianceMessage> nonComplianceMessages = null, IEnumerable<ResourceSelector> resourceSelectors = null, IEnumerable<PolicyOverride> overrides = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

location AzureLocation?

The location of the policy assignment. Only required when utilizing managed identity.

managedIdentity ManagedServiceIdentity

The managed identity associated with the policy assignment. Current supported identity types: None, SystemAssigned, UserAssigned.

displayName string

The display name of the policy assignment.

policyDefinitionId string

The ID of the policy definition or policy set definition being assigned.

scope string

The scope for the policy assignment.

excludedScopes IEnumerable<string>

The policy's excluded scopes.

parameters IDictionary<string, ArmPolicyParameterValue>

The parameter values for the assigned policy rule. The keys are the parameter names.

description string

This message will be part of response in case of policy violation.

metadata BinaryData

The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

enforcementMode EnforcementMode?

The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.

nonComplianceMessages IEnumerable<NonComplianceMessage>

The messages that describe why a resource is non-compliant with the policy.

resourceSelectors IEnumerable<ResourceSelector>

The resource selector list to filter policies by resource properties.

overrides IEnumerable<PolicyOverride>

The policy property value override.

Returns

PolicyAssignmentData

A new PolicyAssignmentData instance for mocking.

PolicyDefinitionData(ResourceIdentifier, string, ResourceType, SystemData, PolicyType?, string, string, string, BinaryData, BinaryData, IDictionary<string, ArmPolicyParameter>)

Initializes a new instance of PolicyDefinitionData.

public static PolicyDefinitionData PolicyDefinitionData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, PolicyType? policyType = null, string mode = null, string displayName = null, string description = null, BinaryData policyRule = null, BinaryData metadata = null, IDictionary<string, ArmPolicyParameter> parameters = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

policyType PolicyType?

The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

mode string

The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.

displayName string

The display name of the policy definition.

description string

The policy definition description.

policyRule BinaryData

The policy rule.

metadata BinaryData

The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

parameters IDictionary<string, ArmPolicyParameter>

The parameter definitions for parameters used in the policy rule. The keys are the parameter names.

Returns

PolicyDefinitionData

A new PolicyDefinitionData instance for mocking.

PolicySetDefinitionData(ResourceIdentifier, string, ResourceType, SystemData, PolicyType?, string, string, BinaryData, IDictionary<string, ArmPolicyParameter>, IEnumerable<PolicyDefinitionReference>, IEnumerable<PolicyDefinitionGroup>)

Initializes a new instance of PolicySetDefinitionData.

public static PolicySetDefinitionData PolicySetDefinitionData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, PolicyType? policyType = null, string displayName = null, string description = null, BinaryData metadata = null, IDictionary<string, ArmPolicyParameter> parameters = null, IEnumerable<PolicyDefinitionReference> policyDefinitions = null, IEnumerable<PolicyDefinitionGroup> policyDefinitionGroups = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

policyType PolicyType?

The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

displayName string

The display name of the policy set definition.

description string

The policy set definition description.

metadata BinaryData

The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

parameters IDictionary<string, ArmPolicyParameter>

The policy set definition parameters that can be used in policy definition references.

policyDefinitions IEnumerable<PolicyDefinitionReference>

An array of policy definition references.

policyDefinitionGroups IEnumerable<PolicyDefinitionGroup>

The metadata describing groups of policy definition references within the policy set definition.

Returns

PolicySetDefinitionData

A new PolicySetDefinitionData instance for mocking.

PredefinedTag(string, string, PredefinedTagCount, IEnumerable<PredefinedTagValue>)

Initializes a new instance of PredefinedTag.

public static PredefinedTag PredefinedTag(string id = null, string tagName = null, PredefinedTagCount count = null, IEnumerable<PredefinedTagValue> values = null)

Parameters

id string

The tag name ID.

tagName string

The tag name.

count PredefinedTagCount

The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0.

values IEnumerable<PredefinedTagValue>

The list of tag values.

Returns

PredefinedTag

A new PredefinedTag instance for mocking.

PredefinedTagCount(string, int?)

Initializes a new instance of PredefinedTagCount.

public static PredefinedTagCount PredefinedTagCount(string predefinedTagCountType = null, int? value = null)

Parameters

predefinedTagCountType string

Type of count.

value int?

Value of count.

Returns

PredefinedTagCount

A new PredefinedTagCount instance for mocking.

PredefinedTagValue(string, string, PredefinedTagCount)

Initializes a new instance of PredefinedTagValue.

public static PredefinedTagValue PredefinedTagValue(string id = null, string tagValue = null, PredefinedTagCount count = null)

Parameters

id string

The tag value ID.

tagValue string

The tag value.

count PredefinedTagCount

The tag value count.

Returns

PredefinedTagValue

A new PredefinedTagValue instance for mocking.

ProviderExtendedLocation(AzureLocation?, string, IEnumerable<string>)

Initializes a new instance of ProviderExtendedLocation.

public static ProviderExtendedLocation ProviderExtendedLocation(AzureLocation? location = null, string providerExtendedLocationType = null, IEnumerable<string> extendedLocations = null)

Parameters

location AzureLocation?

The azure location.

providerExtendedLocationType string

The extended location type.

extendedLocations IEnumerable<string>

The extended locations for the azure location.

Returns

ProviderExtendedLocation

A new ProviderExtendedLocation instance for mocking.

ProviderPermission(string, AzureRoleDefinition, AzureRoleDefinition, ProviderAuthorizationConsentState?)

Initializes a new instance of ProviderPermission.

public static ProviderPermission ProviderPermission(string applicationId = null, AzureRoleDefinition roleDefinition = null, AzureRoleDefinition managedByRoleDefinition = null, ProviderAuthorizationConsentState? providerAuthorizationConsentState = null)

Parameters

applicationId string

The application id.

roleDefinition AzureRoleDefinition

Role definition properties.

managedByRoleDefinition AzureRoleDefinition

Role definition properties.

providerAuthorizationConsentState ProviderAuthorizationConsentState?

The provider authorization consent state.

Returns

ProviderPermission

A new ProviderPermission instance for mocking.

ProviderResourceType(string, IEnumerable<string>, IEnumerable<ProviderExtendedLocation>, IEnumerable<ResourceTypeAlias>, IEnumerable<string>, string, IEnumerable<ZoneMapping>, IEnumerable<ApiProfile>, string, IReadOnlyDictionary<string, string>)

Initializes a new instance of ProviderResourceType.

public static ProviderResourceType ProviderResourceType(string resourceType = null, IEnumerable<string> locations = null, IEnumerable<ProviderExtendedLocation> locationMappings = null, IEnumerable<ResourceTypeAlias> aliases = null, IEnumerable<string> apiVersions = null, string defaultApiVersion = null, IEnumerable<ZoneMapping> zoneMappings = null, IEnumerable<ApiProfile> apiProfiles = null, string capabilities = null, IReadOnlyDictionary<string, string> properties = null)

Parameters

resourceType string

The resource type.

locations IEnumerable<string>

The collection of locations where this resource type can be created.

locationMappings IEnumerable<ProviderExtendedLocation>

The location mappings that are supported by this resource type.

aliases IEnumerable<ResourceTypeAlias>

The aliases that are supported by this resource type.

apiVersions IEnumerable<string>

The API version.

defaultApiVersion string

The default API version.

zoneMappings IEnumerable<ZoneMapping>
apiProfiles IEnumerable<ApiProfile>

The API profiles for the resource provider.

capabilities string

The additional capabilities offered by this resource type.

properties IReadOnlyDictionary<string, string>

The properties.

Returns

ProviderResourceType

A new ProviderResourceType instance for mocking.

ResourceGroupData(ResourceIdentifier, string, ResourceType, SystemData, IDictionary<string, string>, AzureLocation, string, string)

Initializes a new instance of ResourceGroupData.

public static ResourceGroupData ResourceGroupData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, IDictionary<string, string> tags = null, AzureLocation location = null, string resourceGroupProvisioningState = null, string managedBy = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

tags IDictionary<string, string>

The tags.

location AzureLocation

The location.

resourceGroupProvisioningState string

The resource group properties.

managedBy string

The ID of the resource that manages this resource group.

Returns

ResourceGroupData

A new ResourceGroupData instance for mocking.

ResourceGroupExportResult(BinaryData, ResponseError)

Initializes a new instance of ResourceGroupExportResult.

public static ResourceGroupExportResult ResourceGroupExportResult(BinaryData template = null, ResponseError error = null)

Parameters

template BinaryData

The template content.

error ResponseError

The template export error.

Returns

ResourceGroupExportResult

A new ResourceGroupExportResult instance for mocking.

ResourceNameValidationResult(string, ResourceType?, ResourceNameValidationStatus?)

Initializes a new instance of ResourceNameValidationResult.

public static ResourceNameValidationResult ResourceNameValidationResult(string name = null, ResourceType? resourceType = null, ResourceNameValidationStatus? status = null)

Parameters

name string

Name of Resource.

resourceType ResourceType?

Type of Resource.

status ResourceNameValidationStatus?

Is the resource name Allowed or Reserved.

Returns

ResourceNameValidationResult

A new ResourceNameValidationResult instance for mocking.

ResourceProviderData(ResourceIdentifier, string, string, string, IEnumerable<ProviderResourceType>, ProviderAuthorizationConsentState?)

Initializes a new instance of ResourceProviderData.

public static ResourceProviderData ResourceProviderData(ResourceIdentifier id = null, string @namespace = null, string registrationState = null, string registrationPolicy = null, IEnumerable<ProviderResourceType> resourceTypes = null, ProviderAuthorizationConsentState? providerAuthorizationConsentState = null)

Parameters

id ResourceIdentifier

The provider ID.

namespace string

The namespace of the resource provider.

registrationState string

The registration state of the resource provider.

registrationPolicy string

The registration policy of the resource provider.

resourceTypes IEnumerable<ProviderResourceType>

The collection of provider resource types.

providerAuthorizationConsentState ProviderAuthorizationConsentState?

The provider authorization consent state.

Returns

ResourceProviderData

A new ResourceProviderData instance for mocking.

ResourceTypeAlias(string, IEnumerable<ResourceTypeAliasPath>, ResourceTypeAliasType?, string, ResourceTypeAliasPattern, ResourceTypeAliasPathMetadata)

Initializes a new instance of ResourceTypeAlias.

public static ResourceTypeAlias ResourceTypeAlias(string name = null, IEnumerable<ResourceTypeAliasPath> paths = null, ResourceTypeAliasType? aliasType = null, string defaultPath = null, ResourceTypeAliasPattern defaultPattern = null, ResourceTypeAliasPathMetadata defaultMetadata = null)

Parameters

name string

The alias name.

paths IEnumerable<ResourceTypeAliasPath>

The paths for an alias.

aliasType ResourceTypeAliasType?

The type of the alias.

defaultPath string

The default path for an alias.

defaultPattern ResourceTypeAliasPattern

The default pattern for an alias.

defaultMetadata ResourceTypeAliasPathMetadata

The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata.

Returns

ResourceTypeAlias

A new ResourceTypeAlias instance for mocking.

ResourceTypeAliasPath(string, IEnumerable<string>, ResourceTypeAliasPattern, ResourceTypeAliasPathMetadata)

Initializes a new instance of ResourceTypeAliasPath.

public static ResourceTypeAliasPath ResourceTypeAliasPath(string path = null, IEnumerable<string> apiVersions = null, ResourceTypeAliasPattern pattern = null, ResourceTypeAliasPathMetadata metadata = null)

Parameters

path string

The path of an alias.

apiVersions IEnumerable<string>

The API versions.

pattern ResourceTypeAliasPattern

The pattern for an alias path.

metadata ResourceTypeAliasPathMetadata

The metadata of the alias path. If missing, fall back to the default metadata of the alias.

Returns

ResourceTypeAliasPath

A new ResourceTypeAliasPath instance for mocking.

ResourceTypeAliasPathMetadata(ResourceTypeAliasPathTokenType?, ResourceTypeAliasPathAttributes?)

Initializes a new instance of ResourceTypeAliasPathMetadata.

public static ResourceTypeAliasPathMetadata ResourceTypeAliasPathMetadata(ResourceTypeAliasPathTokenType? tokenType = null, ResourceTypeAliasPathAttributes? attributes = null)

Parameters

tokenType ResourceTypeAliasPathTokenType?

The type of the token that the alias path is referring to.

attributes ResourceTypeAliasPathAttributes?

The attributes of the token that the alias path is referring to.

Returns

ResourceTypeAliasPathMetadata

A new ResourceTypeAliasPathMetadata instance for mocking.

ResourceTypeAliasPattern(string, string, ResourceTypeAliasPatternType?)

Initializes a new instance of ResourceTypeAliasPattern.

public static ResourceTypeAliasPattern ResourceTypeAliasPattern(string phrase = null, string variable = null, ResourceTypeAliasPatternType? patternType = null)

Parameters

phrase string

The alias pattern phrase.

variable string

The alias pattern variable.

patternType ResourceTypeAliasPatternType?

The type of alias pattern.

Returns

ResourceTypeAliasPattern

A new ResourceTypeAliasPattern instance for mocking.

ResourceTypeAliases(string, IEnumerable<ResourceTypeAlias>)

Initializes a new instance of ResourceTypeAliases.

public static ResourceTypeAliases ResourceTypeAliases(string resourceType = null, IEnumerable<ResourceTypeAlias> aliases = null)

Parameters

resourceType string

The resource type name.

aliases IEnumerable<ResourceTypeAlias>

The aliases for property names.

Returns

ResourceTypeAliases

A new ResourceTypeAliases instance for mocking.

SubResource(ResourceIdentifier)

Initializes a new instance of SubResource.

public static SubResource SubResource(ResourceIdentifier id = null)

Parameters

id ResourceIdentifier

Returns

SubResource

A new SubResource instance for mocking.

SubscriptionData(ResourceIdentifier, string, string, Guid?, SubscriptionState?, SubscriptionPolicies, string, IEnumerable<ManagedByTenant>, IReadOnlyDictionary<string, string>)

Initializes a new instance of SubscriptionData.

public static SubscriptionData SubscriptionData(ResourceIdentifier id = null, string subscriptionId = null, string displayName = null, Guid? tenantId = null, SubscriptionState? state = null, SubscriptionPolicies subscriptionPolicies = null, string authorizationSource = null, IEnumerable<ManagedByTenant> managedByTenants = null, IReadOnlyDictionary<string, string> tags = null)

Parameters

id ResourceIdentifier

The fully qualified ID for the subscription. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74.

subscriptionId string

The subscription ID.

displayName string

The subscription display name.

tenantId Guid?

The subscription tenant ID.

state SubscriptionState?

The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.

subscriptionPolicies SubscriptionPolicies

The subscription policies.

authorizationSource string

The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.

managedByTenants IEnumerable<ManagedByTenant>

An array containing the tenants managing the subscription.

tags IReadOnlyDictionary<string, string>

The tags attached to the subscription.

Returns

SubscriptionData

A new SubscriptionData instance for mocking.

SubscriptionPolicies(string, string, SpendingLimit?)

Initializes a new instance of SubscriptionPolicies.

public static SubscriptionPolicies SubscriptionPolicies(string locationPlacementId = null, string quotaId = null, SpendingLimit? spendingLimit = null)

Parameters

locationPlacementId string

The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions.

quotaId string

The subscription quota ID.

spendingLimit SpendingLimit?

The subscription spending limit.

Returns

SubscriptionPolicies

A new SubscriptionPolicies instance for mocking.

TagResourceData(ResourceIdentifier, string, ResourceType, SystemData, IDictionary<string, string>)

Initializes a new instance of TagResourceData.

public static TagResourceData TagResourceData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, IDictionary<string, string> tagValues = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

tagValues IDictionary<string, string>

The set of tags.

Returns

TagResourceData

A new TagResourceData instance for mocking.

TenantData(string, Guid?, TenantCategory?, string, string, string, IEnumerable<string>, string, string, Uri)

Initializes a new instance of TenantData.

public static TenantData TenantData(string id = null, Guid? tenantId = null, TenantCategory? tenantCategory = null, string country = null, string countryCode = null, string displayName = null, IEnumerable<string> domains = null, string defaultDomain = null, string tenantType = null, Uri tenantBrandingLogoUri = null)

Parameters

id string

The fully qualified ID of the tenant. For example, /tenants/8d65815f-a5b6-402f-9298-045155da7d74.

tenantId Guid?

The tenant ID. For example, 8d65815f-a5b6-402f-9298-045155da7d74.

tenantCategory TenantCategory?

Category of the tenant.

country string

Country/region name of the address for the tenant.

countryCode string

Country/region abbreviation for the tenant.

displayName string

The display name of the tenant.

domains IEnumerable<string>

The list of domains for the tenant.

defaultDomain string

The default domain for the tenant.

tenantType string

The tenant type. Only available for 'Home' tenant category.

tenantBrandingLogoUri Uri

The tenant's branding logo URL. Only available for 'Home' tenant category.

Returns

TenantData

A new TenantData instance for mocking.

TenantResourceProvider(string, IEnumerable<ProviderResourceType>)

Initializes a new instance of TenantResourceProvider.

public static TenantResourceProvider TenantResourceProvider(string @namespace = null, IEnumerable<ProviderResourceType> resourceTypes = null)

Parameters

namespace string

The namespace of the resource provider.

resourceTypes IEnumerable<ProviderResourceType>

The collection of provider resource types.

Returns

TenantResourceProvider

A new TenantResourceProvider instance for mocking.

TrackedResourceExtendedData(ResourceIdentifier, string, ResourceType, SystemData, IDictionary<string, string>, AzureLocation, ExtendedLocation)

Initializes a new instance of TrackedResourceExtendedData.

public static TrackedResourceExtendedData TrackedResourceExtendedData(ResourceIdentifier id = null, string name = null, ResourceType resourceType = null, SystemData systemData = null, IDictionary<string, string> tags = null, AzureLocation location = null, ExtendedLocation extendedLocation = null)

Parameters

id ResourceIdentifier

The id.

name string

The name.

resourceType ResourceType

The resourceType.

systemData SystemData

The systemData.

tags IDictionary<string, string>

The tags.

location AzureLocation

The location.

extendedLocation ExtendedLocation

Resource extended location.

Returns

TrackedResourceExtendedData

A new TrackedResourceExtendedData instance for mocking.

WritableSubResource(ResourceIdentifier)

Initializes a new instance of WritableSubResource.

public static WritableSubResource WritableSubResource(ResourceIdentifier id = null)

Parameters

id ResourceIdentifier

Returns

WritableSubResource

A new WritableSubResource instance for mocking.

ZoneMapping(AzureLocation?, IEnumerable<string>)

Initializes a new instance of ZoneMapping.

public static ZoneMapping ZoneMapping(AzureLocation? location = null, IEnumerable<string> zones = null)

Parameters

location AzureLocation?

The location of the zone mapping.

zones IEnumerable<string>

Returns

ZoneMapping

A new ZoneMapping instance for mocking.