Skip to content

storage.v1alpha3.account

"An Account is a managed resource that represents an Azure Blob Service Account."

Index

Fields

fn new

new(name)

new returns an instance of Account

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"An AccountSpec defines the desired state of an Account."

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

fn spec.withResourceGroupName

withResourceGroupName(resourceGroupName)

"ResourceGroupName specifies the resource group for this Account."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.storageAccountSpec

"StorageAccountSpec specifies the desired state of this Account."

fn spec.storageAccountSpec.withKind

withKind(kind)

"Kind - Indicates the type of storage account. Possible values include: 'Storage', 'BlobStorage'"

fn spec.storageAccountSpec.withLocation

withLocation(location)

"Location - The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)."

fn spec.storageAccountSpec.withTags

withTags(tags)

"Tags - A list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters."

fn spec.storageAccountSpec.withTagsMixin

withTagsMixin(tags)

"Tags - A list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters."

Note: This function appends passed data to existing values

obj spec.storageAccountSpec.identity

"Identity - The identity of the resource."

fn spec.storageAccountSpec.identity.withPrincipalId

withPrincipalId(principalId)

"PrincipalID - The principal ID of resource identity."

fn spec.storageAccountSpec.identity.withTenantId

withTenantId(tenantId)

"TenantID - The tenant ID of resource."

fn spec.storageAccountSpec.identity.withType

withType(type)

"Type - The identity type."

obj spec.storageAccountSpec.properties

"StorageAccountSpecProperties - The parameters used to create the storage account."

fn spec.storageAccountSpec.properties.withAccessTier

withAccessTier(accessTier)

"AccessTier - Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool'"

fn spec.storageAccountSpec.properties.withSupportsHttpsTrafficOnly

withSupportsHttpsTrafficOnly(supportsHttpsTrafficOnly)

"EnableHTTPSTrafficOnly - Allows https traffic only to storage service if sets to true."

obj spec.storageAccountSpec.properties.customDomain

"CustomDomain - User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. to clear the existing custom domain, use an empty string for the custom domain name property."

fn spec.storageAccountSpec.properties.customDomain.withName

withName(name)

"Name - custom domain name assigned to the storage account. Name is the CNAME source."

fn spec.storageAccountSpec.properties.customDomain.withUseSubDomainName

withUseSubDomainName(useSubDomainName)

"UseSubDomainName - Indicates whether indirect CNAME validation is enabled."

obj spec.storageAccountSpec.properties.encryption

"Encryption - Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted."

fn spec.storageAccountSpec.properties.encryption.withKeySource

withKeySource(keySource)

"KeySource - The encryption keySource (provider). \n Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault"

obj spec.storageAccountSpec.properties.encryption.keyvaultproperties

"KeyVaultProperties - Properties provided by key vault."

fn spec.storageAccountSpec.properties.encryption.keyvaultproperties.withKeyname

withKeyname(keyname)

"KeyName - The name of KeyVault key."

fn spec.storageAccountSpec.properties.encryption.keyvaultproperties.withKeyvaulturi

withKeyvaulturi(keyvaulturi)

"KeyVaultURI - The Uri of KeyVault."

fn spec.storageAccountSpec.properties.encryption.keyvaultproperties.withKeyversion

withKeyversion(keyversion)

"KeyVersion - The version of KeyVault key."

obj spec.storageAccountSpec.properties.encryption.services

"Services - List of services which support encryption."

fn spec.storageAccountSpec.properties.encryption.services.withBlob

withBlob(blob)

"Blob - The encryption function of the blob storage service."

fn spec.storageAccountSpec.properties.encryption.services.withFile

withFile(file)

"File - The encryption function of the file storage service."

obj spec.storageAccountSpec.properties.networkAcls

"NetworkRuleSet - Network rule set"

fn spec.storageAccountSpec.properties.networkAcls.withBypass

withBypass(bypass)

"Bypass - Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, \"Logging, Metrics\"), or None to bypass none of those traffics. Possible values include: 'None', 'Logging', 'Metrics', 'AzureServices'"

fn spec.storageAccountSpec.properties.networkAcls.withDefaultAction

withDefaultAction(defaultAction)

"DefaultAction - Specifies the default action of allow or deny when no other rules match. \n Possible values include: 'Allow', 'Deny'"

fn spec.storageAccountSpec.properties.networkAcls.withIpRules

withIpRules(ipRules)

"IPRules - Sets the IP ACL rules"

fn spec.storageAccountSpec.properties.networkAcls.withIpRulesMixin

withIpRulesMixin(ipRules)

"IPRules - Sets the IP ACL rules"

Note: This function appends passed data to existing values

fn spec.storageAccountSpec.properties.networkAcls.withVirtualNetworkRules

withVirtualNetworkRules(virtualNetworkRules)

"VirtualNetworkRules - Sets the virtual network rules"

fn spec.storageAccountSpec.properties.networkAcls.withVirtualNetworkRulesMixin

withVirtualNetworkRulesMixin(virtualNetworkRules)

"VirtualNetworkRules - Sets the virtual network rules"

Note: This function appends passed data to existing values

obj spec.storageAccountSpec.properties.networkAcls.ipRules

"IPRules - Sets the IP ACL rules"

fn spec.storageAccountSpec.properties.networkAcls.ipRules.withAction

withAction(action)

"Action - The action of IP ACL rule. Possible values include: 'Allow'"

fn spec.storageAccountSpec.properties.networkAcls.ipRules.withValue

withValue(value)

"IPAddressOrRange - Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."

obj spec.storageAccountSpec.properties.networkAcls.virtualNetworkRules

"VirtualNetworkRules - Sets the virtual network rules"

fn spec.storageAccountSpec.properties.networkAcls.virtualNetworkRules.withAction

withAction(action)

"Action - The action of virtual network rule. Possible values include: 'Allow'"

fn spec.storageAccountSpec.properties.networkAcls.virtualNetworkRules.withId

withId(id)

"VirtualNetworkResourceID - Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}."

obj spec.storageAccountSpec.sku

"Sku of the storage account."

fn spec.storageAccountSpec.sku.withCapabilities

withCapabilities(capabilities)

"Capabilities - The capability information in the specified sku, including file encryption, network acls, change notification, etc."

fn spec.storageAccountSpec.sku.withCapabilitiesMixin

withCapabilitiesMixin(capabilities)

"Capabilities - The capability information in the specified sku, including file encryption, network acls, change notification, etc."

Note: This function appends passed data to existing values

fn spec.storageAccountSpec.sku.withKind

withKind(kind)

"Kind - Indicates the type of storage account. \n Possible values include: 'Storage', 'BlobStorage'"

fn spec.storageAccountSpec.sku.withLocations

withLocations(locations)

"Locations - The set of locations that the Sku is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)."

fn spec.storageAccountSpec.sku.withLocationsMixin

withLocationsMixin(locations)

"Locations - The set of locations that the Sku is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)."

Note: This function appends passed data to existing values

fn spec.storageAccountSpec.sku.withName

withName(name)

"Name - Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. \n Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'"

fn spec.storageAccountSpec.sku.withResourceType

withResourceType(resourceType)

"ResourceType - The type of the resource, usually it is 'storageAccounts'."

fn spec.storageAccountSpec.sku.withTier

withTier(tier)

"Tier - Gets the sku tier. This is based on the Sku name. \n Possible values include: 'Standard', 'Premium'"

obj spec.storageAccountSpec.sku.capabilities

"Capabilities - The capability information in the specified sku, including file encryption, network acls, change notification, etc."

fn spec.storageAccountSpec.sku.capabilities.withName

withName(name)

"Name - The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc."

fn spec.storageAccountSpec.sku.capabilities.withValue

withValue(value)

"Value - A string value to indicate states of given capability. Possibly 'true' or 'false'."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."